diff options
author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-12-29 15:48:26 -0500 |
---|---|---|
committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-12-30 07:34:59 -0500 |
commit | ea0dd85a75f15174cc2bf75f805e378391995931 (patch) | |
tree | e2dc904067a98bec44e04ca870b46d4e4434de9e /drivers/gpu/drm/drm_framebuffer.c | |
parent | e9b4d7b56f293ed4de9ff7d16759d33492f83180 (diff) |
drm/doc: use preferred struct reference in kernel-doc
sed -e 's/\( \* .*\)struct &\([_a-z]*\)/\1\&struct \2/' -i
Originally I wasnt a friend of this style because I thought a
line-break between the "&struct" and "foo" part would break it. But a
quick test shows that " * &struct \n * foo\n" works pefectly well with
current kernel-doc. So time to mass-apply these changes!
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Chris Wilson <chris@chris-wilson.co.uk>
Reviewed-by: David Herrmann <dh.herrmann@gmail.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-6-git-send-email-daniel.vetter@ffwll.ch
Diffstat (limited to 'drivers/gpu/drm/drm_framebuffer.c')
-rw-r--r-- | drivers/gpu/drm/drm_framebuffer.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/drivers/gpu/drm/drm_framebuffer.c b/drivers/gpu/drm/drm_framebuffer.c index 94ddab41f24f..588ccc3a2218 100644 --- a/drivers/gpu/drm/drm_framebuffer.c +++ b/drivers/gpu/drm/drm_framebuffer.c | |||
@@ -39,13 +39,13 @@ | |||
39 | * Frame buffers rely on the underlying memory manager for allocating backing | 39 | * Frame buffers rely on the underlying memory manager for allocating backing |
40 | * storage. When creating a frame buffer applications pass a memory handle | 40 | * storage. When creating a frame buffer applications pass a memory handle |
41 | * (or a list of memory handles for multi-planar formats) through the | 41 | * (or a list of memory handles for multi-planar formats) through the |
42 | * struct &drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace | 42 | * &struct drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace |
43 | * buffer management interface this would be a GEM handle. Drivers are however | 43 | * buffer management interface this would be a GEM handle. Drivers are however |
44 | * free to use their own backing storage object handles, e.g. vmwgfx directly | 44 | * free to use their own backing storage object handles, e.g. vmwgfx directly |
45 | * exposes special TTM handles to userspace and so expects TTM handles in the | 45 | * exposes special TTM handles to userspace and so expects TTM handles in the |
46 | * create ioctl and not GEM handles. | 46 | * create ioctl and not GEM handles. |
47 | * | 47 | * |
48 | * Framebuffers are tracked with struct &drm_framebuffer. They are published | 48 | * Framebuffers are tracked with &struct drm_framebuffer. They are published |
49 | * using drm_framebuffer_init() - after calling that function userspace can use | 49 | * using drm_framebuffer_init() - after calling that function userspace can use |
50 | * and access the framebuffer object. The helper function | 50 | * and access the framebuffer object. The helper function |
51 | * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required | 51 | * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required |
@@ -55,7 +55,7 @@ | |||
55 | * drivers can grab additional references with drm_framebuffer_reference() and | 55 | * drivers can grab additional references with drm_framebuffer_reference() and |
56 | * drop them again with drm_framebuffer_unreference(). For driver-private | 56 | * drop them again with drm_framebuffer_unreference(). For driver-private |
57 | * framebuffers for which the last reference is never dropped (e.g. for the | 57 | * framebuffers for which the last reference is never dropped (e.g. for the |
58 | * fbdev framebuffer when the struct struct &drm_framebuffer is embedded into | 58 | * fbdev framebuffer when the struct &struct drm_framebuffer is embedded into |
59 | * the fbdev helper struct) drivers can manually clean up a framebuffer at | 59 | * the fbdev helper struct) drivers can manually clean up a framebuffer at |
60 | * module unload time with drm_framebuffer_unregister_private(). But doing this | 60 | * module unload time with drm_framebuffer_unregister_private(). But doing this |
61 | * is not recommended, and it's better to have a normal free-standing struct | 61 | * is not recommended, and it's better to have a normal free-standing struct |