1

drm/doc: use cross-references for macros

These will show up as monospace, and will get linkified as soon as
we document the macro they point to.

Signed-off-by: Simon Ser <contact@emersion.fr>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20230712135723.173506-1-contact@emersion.fr
This commit is contained in:
Simon Ser 2023-07-12 13:57:26 +00:00
parent f2971219a9
commit f70a669175

View File

@ -527,12 +527,12 @@ VBlank event handling
The DRM core exposes two vertical blank related ioctls: The DRM core exposes two vertical blank related ioctls:
DRM_IOCTL_WAIT_VBLANK :c:macro:`DRM_IOCTL_WAIT_VBLANK`
This takes a struct drm_wait_vblank structure as its argument, and This takes a struct drm_wait_vblank structure as its argument, and
it is used to block or request a signal when a specified vblank it is used to block or request a signal when a specified vblank
event occurs. event occurs.
DRM_IOCTL_MODESET_CTL :c:macro:`DRM_IOCTL_MODESET_CTL`
This was only used for user-mode-settind drivers around modesetting This was only used for user-mode-settind drivers around modesetting
changes to allow the kernel to update the vblank interrupt after changes to allow the kernel to update the vblank interrupt after
mode setting, since on many devices the vertical blank counter is mode setting, since on many devices the vertical blank counter is
@ -555,8 +555,8 @@ The index is used in cases where a densely packed identifier for a CRTC is
needed, for instance a bitmask of CRTC's. The member possible_crtcs of struct needed, for instance a bitmask of CRTC's. The member possible_crtcs of struct
drm_mode_get_plane is an example. drm_mode_get_plane is an example.
DRM_IOCTL_MODE_GETRESOURCES populates a structure with an array of CRTC ID's, :c:macro:`DRM_IOCTL_MODE_GETRESOURCES` populates a structure with an array of
and the CRTC index is its position in this array. CRTC ID's, and the CRTC index is its position in this array.
.. kernel-doc:: include/uapi/drm/drm.h .. kernel-doc:: include/uapi/drm/drm.h
:internal: :internal: