drm/doc: demote old doc-comments in drm.h
authorSimon Ser <contact@emersion.fr>
Tue, 22 Dec 2020 13:35:23 +0000 (14:35 +0100)
committerSimon Ser <contact@emersion.fr>
Tue, 5 Jan 2021 13:22:07 +0000 (14:22 +0100)
commit0e0dc448005583a602c8751b7d4cb9e994dd2314
tree0c178550bb9f3f92dca93fc158b885458922cd6f
parent877c39acf507d5447fca0459febb6aa04eb5ed7f
drm/doc: demote old doc-comments in drm.h

Sphinx doesn't like old doc-comments in drm.h and generates warnings
like:

    ./include/uapi/drm/drm.h:87: warning: cannot understand function prototype: 'struct drm_clip_rect '
    ./include/uapi/drm/drm.h:97: warning: cannot understand function prototype: 'struct drm_drawable_info '
    ./include/uapi/drm/drm.h:105: warning: cannot understand function prototype: 'struct drm_tex_region '
    ...

Demote these to regular comments, because converting all of them is
quite a lot of work (also requires documenting all of the struct fields
for instance). Also many of these structures aren't really used by
modern user-space.

We can easily convert these remaining old comments to Sphinx style on a
one-by-one basis.

Signed-off-by: Simon Ser <contact@emersion.fr>
Acked-by: Daniel Vetter <daniel@ffwll.ch>
Cc: Pekka Paalanen <ppaalanen@gmail.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20201222133524.160842-5-contact@emersion.fr
include/uapi/drm/drm.h