From: Kevin Paul Reddy Janagari <kevinpaul468@gmail.com>
To: airlied@gmail.com, simona@ffwll.ch,
maarten.lankhorst@linux.intel.com, mripard@kernel.org,
tzimmermann@suse.de, corbet@lwn.net,
dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, kevinpaul468@gmail.com
Subject: [PATCH v3] workaround for Sphinx false positive preventing indexing
Date: Wed, 2 Jul 2025 21:43:37 +0530 [thread overview]
Message-ID: <20250702161337.69943-1-kevinpaul468@gmail.com> (raw)
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
This is a bug of Sphinx >=3.1, first reported by Mauro in September 2020
Link: https://github.com/sphinx-doc/sphinx/issues/8241
Open Pull Request
Link: https://github.com/sphinx-doc/sphinx/pull/8313
Signed-off-by: Kevin Paul Reddy Janagari <kevinpaul468@gmail.com>
---
Documentation/gpu/drm-kms.rst | 4 ++++
Documentation/gpu/drm-uapi.rst | 2 ++
2 files changed, 6 insertions(+)
diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
index abfe220764e1..b18a99869b6d 100644
--- a/Documentation/gpu/drm-kms.rst
+++ b/Documentation/gpu/drm-kms.rst
@@ -357,8 +357,10 @@ Format Functions Reference
.. kernel-doc:: include/drm/drm_fourcc.h
:internal:
+.. c:namespace-push:: gpu_drm
.. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
:export:
+.. c:namespace-pop::
.. _kms_dumb_buffer_objects:
@@ -473,8 +475,10 @@ KMS Locking
.. kernel-doc:: include/drm/drm_modeset_lock.h
:internal:
+.. c:namespace:: gpu_drm
.. kernel-doc:: drivers/gpu/drm/drm_modeset_lock.c
:export:
+.. c:namespace-pop::
KMS Properties
==============
diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 69f72e71a96e..e9d7b7282a19 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -554,8 +554,10 @@ DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of
.. kernel-doc:: include/drm/drm_ioctl.h
:internal:
+.. c:namespace-push:: gpu_drm
.. kernel-doc:: drivers/gpu/drm/drm_ioctl.c
:export:
+.. c:namespace-pop::
.. kernel-doc:: drivers/gpu/drm/drm_ioc32.c
:export:
--
2.39.5
next reply other threads:[~2025-07-02 16:14 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-02 16:13 Kevin Paul Reddy Janagari [this message]
2025-08-18 9:34 ` workaround for Sphinx false positive preventing indexing Kevin Paul Reddy Janagari
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250702161337.69943-1-kevinpaul468@gmail.com \
--to=kevinpaul468@gmail.com \
--cc=airlied@gmail.com \
--cc=corbet@lwn.net \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mripard@kernel.org \
--cc=simona@ffwll.ch \
--cc=tzimmermann@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).