[PATCH] workaround for Sphinx false positive preventing index
Kevin Paul Reddy Janagari
kevinpaul468 at gmail.com
Fri Jun 27 07:16:28 UTC 2025
Functions drm_format_info, drm_modeset_lock, drm_ioctl_flags are not being
indexed in the documentation because there are structs with the same name
and sphinx is only indexing one of them, Added them to namespaces as a
workaround for suppressing the warnings and indexing the functions
Signed-off-by: Kevin Paul Reddy Janagari <kevinpaul468 at gmail.com>
---
Documentation/gpu/drm-kms.rst | 2 ++
Documentation/gpu/drm-uapi.rst | 1 +
2 files changed, 3 insertions(+)
diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
index abfe220764e1..da865ba1c014 100644
--- a/Documentation/gpu/drm-kms.rst
+++ b/Documentation/gpu/drm-kms.rst
@@ -357,6 +357,7 @@ Format Functions Reference
.. kernel-doc:: include/drm/drm_fourcc.h
:internal:
+.. c:namespace:: gpu_drm_fourcc
.. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
:export:
@@ -473,6 +474,7 @@ KMS Locking
.. kernel-doc:: include/drm/drm_modeset_lock.h
:internal:
+.. c:namespace:: gpu_drm_modeset_lock
.. kernel-doc:: drivers/gpu/drm/drm_modeset_lock.c
:export:
diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 69f72e71a96e..37a2bc461326 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -554,6 +554,7 @@ DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of
.. kernel-doc:: include/drm/drm_ioctl.h
:internal:
+.. c:namespace:: gpu_drm
.. kernel-doc:: drivers/gpu/drm/drm_ioctl.c
:export:
--
2.39.5
More information about the dri-devel
mailing list