drm/doc: Document drm_file.[hc]
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Wed, 8 Mar 2017 14:12:44 +0000 (15:12 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 14 Mar 2017 13:38:33 +0000 (14:38 +0100)
commitb93658f83fa7f89cde5cfba7158da2be8cac42b2
treefd39bd7cc02e2d6f40734b252474c0265af3ab81
parent7d52cb88c9ca20c32288de6ed62b32410c936ccc
drm/doc: Document drm_file.[hc]

Well, mostly drm_file.h, and clean up all related things:

- I didnt' figure out the difference between preclose and postclose.
  The existing explanation in drm-internals.rst didn't convince me,
  since it's also really outdated - we clean up pending DRM events in
  the core nowadays. I put a FIXME in for the future.

- Another FIXME is to have a macro for default fops.

- Lots of links all around, main areas are to tie the overview in
  drm_file.c more into the callbacks in struct drm_device, and the
  other is to link render/primary node code to the right sections in
  drm-uapi.rst.

- Also moved the open/close stuff to drm_drv.h from drm-internals.rst,
  seems like the better place for that information. Since that section
  was rather outdated this amounted to full-on rewrite.

A big missing piece here is some overview graph, but I think better to
wait with that one until drm_device and drm_driver are also fully
documented.

v2: Nits from Sean.

Reviewed-by: Sean Paul <seanpaul@chromium.org>
Reviewed-by: Liviu Dudau <Liviu.Dudau@arm.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/20170308141257.12119-12-daniel.vetter@ffwll.ch
Documentation/gpu/drm-internals.rst
Documentation/gpu/drm-uapi.rst
drivers/gpu/drm/drm_file.c
include/drm/drm_drv.h
include/drm/drm_file.h