]> git.karo-electronics.de Git - karo-tx-linux.git/commit
drm: document drm_ioctl.[hc]
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 4 Apr 2017 09:52:57 +0000 (11:52 +0200)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 4 Apr 2017 18:47:54 +0000 (20:47 +0200)
commit2640981f36004085eeff65849410121809fcf560
treea5fca76487eb67cbb00b277bfe07ec165b64156f
parente22717046a7da3cd0c0b0eec323e1dc38c777a42
drm: document drm_ioctl.[hc]

Also unify/merge with the existing stuff.

I was a bit torn where to put this, but in the end I decided to put
all the ioctl/sysfs/debugfs stuff into drm-uapi.rst. That means we
have a bit a split with the other uapi related stuff used internally,
like drm_file.[hc], but I think overall this makes more sense.

If it's too confusing we can always add more cross-links to make it
more discoverable. But the auto-sprinkling of links kernel-doc already
does seems sufficient.

Also for prettier docs and more cross-links, switch the internal
defines over to an enum, as usual.

v2: Update kerneldoc fro drm_compat_ioctl too (caught by 0day), plus a
bit more drive-by polish.

v3: Fix typo, spotted by xerpi on irc (Sergi).

v4: Add missing space in comment (Neil).

Cc: Sergi Granell <xerpi.g.12@gmail.com>
Reviewed-by: Neil Armstrong <narmstrong@baylibre.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/20170404095304.17599-4-daniel.vetter@ffwll.ch
Documentation/gpu/drm-internals.rst
Documentation/gpu/drm-uapi.rst
drivers/gpu/drm/drm_ioc32.c
drivers/gpu/drm/drm_ioctl.c
include/drm/drm_ioctl.h