Skip to content

Commit f70a669

Browse files
committed
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
1 parent f297121 commit f70a669

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/gpu/drm-uapi.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -527,12 +527,12 @@ VBlank event handling
527527

528528
The DRM core exposes two vertical blank related ioctls:
529529

530-
DRM_IOCTL_WAIT_VBLANK
530+
:c:macro:`DRM_IOCTL_WAIT_VBLANK`
531531
This takes a struct drm_wait_vblank structure as its argument, and
532532
it is used to block or request a signal when a specified vblank
533533
event occurs.
534534

535-
DRM_IOCTL_MODESET_CTL
535+
:c:macro:`DRM_IOCTL_MODESET_CTL`
536536
This was only used for user-mode-settind drivers around modesetting
537537
changes to allow the kernel to update the vblank interrupt after
538538
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
555555
needed, for instance a bitmask of CRTC's. The member possible_crtcs of struct
556556
drm_mode_get_plane is an example.
557557

558-
DRM_IOCTL_MODE_GETRESOURCES populates a structure with an array of CRTC ID's,
559-
and the CRTC index is its position in this array.
558+
:c:macro:`DRM_IOCTL_MODE_GETRESOURCES` populates a structure with an array of
559+
CRTC ID's, and the CRTC index is its position in this array.
560560

561561
.. kernel-doc:: include/uapi/drm/drm.h
562562
:internal:

0 commit comments

Comments
 (0)