Skip to content

Commit 9a2eabf

Browse files
committed
drm/doc: use proper cross-references for sections
When I originally wrote these docs, I couldn't manage to insert a cross-reference to a section. Here's how it can be done. Signed-off-by: Simon Ser <[email protected]> Reviewed-by: Jani Nikula <[email protected]> Acked-by: Daniel Vetter <[email protected]> Cc: Pekka Paalanen <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent 1e8ea2e commit 9a2eabf

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

Documentation/gpu/drm-mm.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,8 @@ DRM Cache Handling and Fast WC memcpy()
517517
.. kernel-doc:: drivers/gpu/drm/drm_cache.c
518518
:export:
519519

520+
.. _drm_sync_objects:
521+
520522
DRM Sync Objects
521523
===========================
522524

include/uapi/drm/drm.h

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -673,8 +673,8 @@ struct drm_gem_open {
673673
* Bitfield of supported PRIME sharing capabilities. See &DRM_PRIME_CAP_IMPORT
674674
* and &DRM_PRIME_CAP_EXPORT.
675675
*
676-
* PRIME buffers are exposed as dma-buf file descriptors. See
677-
* Documentation/gpu/drm-mm.rst, section "PRIME Buffer Sharing".
676+
* PRIME buffers are exposed as dma-buf file descriptors.
677+
* See :ref:`prime_buffer_sharing`.
678678
*/
679679
#define DRM_CAP_PRIME 0x5
680680
/**
@@ -756,15 +756,14 @@ struct drm_gem_open {
756756
/**
757757
* DRM_CAP_SYNCOBJ
758758
*
759-
* If set to 1, the driver supports sync objects. See
760-
* Documentation/gpu/drm-mm.rst, section "DRM Sync Objects".
759+
* If set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`.
761760
*/
762761
#define DRM_CAP_SYNCOBJ 0x13
763762
/**
764763
* DRM_CAP_SYNCOBJ_TIMELINE
765764
*
766765
* If set to 1, the driver supports timeline operations on sync objects. See
767-
* Documentation/gpu/drm-mm.rst, section "DRM Sync Objects".
766+
* :ref:`drm_sync_objects`.
768767
*/
769768
#define DRM_CAP_SYNCOBJ_TIMELINE 0x14
770769

0 commit comments

Comments
 (0)