Skip to content

Commit a0e7ff1

Browse files
kevinpaul468intel-lab-lkp
authored andcommitted
workaround for Sphinx false positive preventing indexing
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: sphinx-doc/sphinx#8241 Open Pull Request Link: sphinx-doc/sphinx#8313 Signed-off-by: Kevin Paul Reddy Janagari <[email protected]>
1 parent f304c25 commit a0e7ff1

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

Documentation/gpu/drm-kms.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,10 @@ Format Functions Reference
357357
.. kernel-doc:: include/drm/drm_fourcc.h
358358
:internal:
359359

360+
.. c:namespace-push:: gpu_drm
360361
.. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
361362
:export:
363+
.. c:namespace-pop::
362364
363365
.. _kms_dumb_buffer_objects:
364366

@@ -473,8 +475,10 @@ KMS Locking
473475
.. kernel-doc:: include/drm/drm_modeset_lock.h
474476
:internal:
475477

478+
.. c:namespace:: gpu_drm
476479
.. kernel-doc:: drivers/gpu/drm/drm_modeset_lock.c
477480
:export:
481+
.. c:namespace-pop::
478482
479483
KMS Properties
480484
==============

Documentation/gpu/drm-uapi.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,10 @@ DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of
554554
.. kernel-doc:: include/drm/drm_ioctl.h
555555
:internal:
556556

557+
.. c:namespace-push:: gpu_drm
557558
.. kernel-doc:: drivers/gpu/drm/drm_ioctl.c
558559
:export:
560+
.. c:namespace-pop::
559561
560562
.. kernel-doc:: drivers/gpu/drm/drm_ioc32.c
561563
:export:

0 commit comments

Comments
 (0)