public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: sanjayembeddedse@gmail.com
Cc: airlied@gmail.com, corbet@lwn.net,
	dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, maarten.lankhorst@linux.intel.com,
	mripard@kernel.org, simona@ffwll.ch, skhan@linuxfoundation.org,
	tzimmermann@suse.de
Subject: Re: [PATCH] Documentation/gpu: resolve kerneldoc duplicate declaration warning
Date: Thu, 16 Apr 2026 14:41:12 +0900	[thread overview]
Message-ID: <6d754f54-d1c8-4175-a0f0-dd51eb26930d@gmail.com> (raw)
In-Reply-To: <A2B5F0ED-8C58-4A88-A4EA-8DA50289ECB5@gmail.com>

Hello,

> On 18 March 2026 8:06:12 pm IST, Sanjay Chitroda <sanjayembeddedse@gmail.com> wrote:
>>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
> 
> Hi all,
> 
> Requesting your input on the change.
> Is there anything that I missed or required correction ?

Your patch is ignored because there is no duplicate in those identifiers.
As you are well aware of, you can have a function and a struct of
the same name.

It is a long-standing bug (almost 6 years now!) in Sphinx C-domain support.

Please have a look at my earlier email:

    https://lore.kernel.org/f735ce0b-db1e-49bc-86ac-b5ab8e4aec31@gmail.com/

It is dated "26 Mar 2024", but the issue remains unresolved.

I'd appreciate if you could make some contribution for fixing the Sphinx
bug.

Regards, Akira

PS: Please ignore several typos I made in the earlier email ;-)


      reply	other threads:[~2026-04-16  5:41 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-18 14:36 [PATCH] Documentation/gpu: resolve kerneldoc duplicate declaration warning Sanjay Chitroda
2026-04-16  2:17 ` Sanjay Chitroda
2026-04-16  5:41   ` Akira Yokosawa [this message]

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=6d754f54-d1c8-4175-a0f0-dd51eb26930d@gmail.com \
    --to=akiyks@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=sanjayembeddedse@gmail.com \
    --cc=simona@ffwll.ch \
    --cc=skhan@linuxfoundation.org \
    --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