[PATCH] Documentation/gpu: resolve kerneldoc duplicate declaration warning

Sanjay Chitroda posted 1 patch 2 weeks, 5 days ago
Documentation/gpu/drm-kms.rst  | 2 ++
Documentation/gpu/drm-uapi.rst | 3 ++-
2 files changed, 4 insertions(+), 1 deletion(-)
[PATCH] Documentation/gpu: resolve kerneldoc duplicate declaration warning
Posted by Sanjay Chitroda 2 weeks, 5 days ago
From: Sanjay Chitroda <sanjayembeddedse@gmail.com>

kernel-doc build with `make htmldocs` reports following WARNINGS.

  Documentation/gpu/drm-kms:360: ../drivers/gpu/drm/drm_fourcc.c:397:
  WARNING: Duplicate C declaration, also defined at gpu/drm-kms:35.
  Declaration is '.. c:function::
  const struct drm_format_info * drm_format_info (u32 format)'.

  Documentation/gpu/drm-kms:491: ../drivers/gpu/drm/drm_modeset_lock.c:377:
  WARNING: Duplicate C declaration, also defined at gpu/drm-kms:48.
  Declaration is '.. c:function:: int drm_modeset_lock
  (struct drm_modeset_lock *lock, struct drm_modeset_acquire_ctx *ctx)'.

  Documentation/gpu/drm-uapi:607: ../drivers/gpu/drm/drm_ioctl.c:923:
  WARNING: Duplicate C declaration, also defined at gpu/drm-uapi:69.
  Declaration is '.. c:function::
  bool drm_ioctl_flags (unsigned int nr, unsigned int *flags)'.

Add :no-identifiers: to prevent duplicate identifier generation and
keep the function documented at its implementation site.

No functional change.

Link: https://lore.kernel.org/oe-kbuild-all/202512302319.1PGGt3CN-lkp@intel.com/
Signed-off-by: Sanjay Chitroda <sanjayembeddedse@gmail.com>
---
 Documentation/gpu/drm-kms.rst  | 2 ++
 Documentation/gpu/drm-uapi.rst | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
index 2292e65f044c..0f0f90b3186d 100644
--- a/Documentation/gpu/drm-kms.rst
+++ b/Documentation/gpu/drm-kms.rst
@@ -356,6 +356,7 @@ Format Functions Reference
 
 .. kernel-doc:: include/drm/drm_fourcc.h
    :internal:
+   :no-identifiers: drm_format_info
 
 .. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
    :export:
@@ -487,6 +488,7 @@ KMS Locking
 
 .. kernel-doc:: include/drm/drm_modeset_lock.h
    :internal:
+   :no-identifiers: 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 d98428a592f1..73b49e0dcda8 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -603,6 +603,7 @@ DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of
 
 .. kernel-doc:: include/drm/drm_ioctl.h
    :internal:
+   :no-identifiers: drm_ioctl_flags
 
 .. kernel-doc:: drivers/gpu/drm/drm_ioctl.c
    :export:
@@ -761,4 +762,4 @@ Stable uAPI events
 From ``drivers/gpu/drm/scheduler/gpu_scheduler_trace.h``
 
 .. kernel-doc::  drivers/gpu/drm/scheduler/gpu_scheduler_trace.h
-   :doc: uAPI trace events
\ No newline at end of file
+   :doc: uAPI trace events
-- 
2.34.1