[PATCH 1/4] drm/doc: use cross-references for macros

[Pekka Paalanen]

On Wed, 12 Jul 2023 13:57:26 +0000
Simon Ser <contact at emersion.fr> wrote:

> 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 at emersion.fr>
> Cc: Pekka Paalanen <pekka.paalanen at collabora.com>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> ---
>  Documentation/gpu/drm-uapi.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
> index 65fb3036a580..f2fe6e8bd018 100644
> --- a/Documentation/gpu/drm-uapi.rst
> +++ b/Documentation/gpu/drm-uapi.rst
> @@ -450,12 +450,12 @@ VBlank event handling
>  
>  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
>      it is used to block or request a signal when a specified vblank
>      event occurs.
>  
> -DRM_IOCTL_MODESET_CTL
> +:c:macro:`DRM_IOCTL_MODESET_CTL`
>      This was only used for user-mode-settind drivers around modesetting
>      changes to allow the kernel to update the vblank interrupt after
>      mode setting, since on many devices the vertical blank counter is
> @@ -478,8 +478,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
>  drm_mode_get_plane is an example.
>  
> -DRM_IOCTL_MODE_GETRESOURCES populates a structure with an array of CRTC ID's,
> -and the CRTC index is its position in this array.
> +:c:macro:`DRM_IOCTL_MODE_GETRESOURCES` populates a structure with an array of
> +CRTC ID's, and the CRTC index is its position in this array.
>  
>  .. kernel-doc:: include/uapi/drm/drm.h
>     :internal:

An excellent idea, and the syntax doesn't look obviously incorrect to
me, so

Acked-by: Pekka Paalanen <pekka.paalanen at collabora.com>


Thanks
pq