Commit f5a8d877 authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/doc: Update styleguide 



The new cool is &struct foo (kernel-doc now copes with linebreaks),
and structure members should be referenced using &foo.bar.

Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Chris Wilson <chris@chris-wilson.co.uk>
Reviewed-by: default avatarDavid Herrmann <dh.herrmann@gmail.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-8-git-send-email-daniel.vetter@ffwll.ch
parent 347e8903

Documentation/gpu/introduction.rst

+6 −7
Original line number Original line Diff line number Diff line
@@ -23,13 +23,12 @@ For consistency this documentation uses American English. Abbreviations 
are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so

are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so

on. To aid in reading, documentations make full use of the markup

on. To aid in reading, documentations make full use of the markup

characters kerneldoc provides: @parameter for function parameters,

characters kerneldoc provides: @parameter for function parameters,

@member for structure members, &structure to reference structures and

@member for structure members (within the same structure), &struct structure to

function() for functions. These all get automatically hyperlinked if

reference structures and function() for functions. These all get automatically

kerneldoc for the referenced objects exists. When referencing entries in

hyperlinked if kerneldoc for the referenced objects exists. When referencing

function vtables please use ->vfunc(). Note that kerneldoc does not

entries in function vtables (and structure members in general) please use

support referencing struct members directly, so please add a reference

&vtable_name.vfunc. Unfortunately this does not yet yield a direct link to the

to the vtable struct somewhere in the same paragraph or at least

member, only the structure.

section.





Except in special situations (to separate locked from unlocked variants)

Except in special situations (to separate locked from unlocked variants)

locking requirements for functions aren't documented in the kerneldoc.

locking requirements for functions aren't documented in the kerneldoc.