From: Randy Dunlap <rdunlap@infradead.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: amd-gfx@lists.freedesktop.org, corbet@lwn.net,
dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: scripts/kernel-doc does not handle duplicate struct & function names (e.g., in amdgpu)
Date: Tue, 11 Jul 2023 20:45:18 -0700 [thread overview]
Message-ID: <58cafdc0-0209-cfdd-c8e0-2dd25d73a184@infradead.org> (raw)
In-Reply-To: <0475d177-4c01-0988-0b34-3099dd703498@gmail.com>
On 7/11/23 20:32, Akira Yokosawa wrote:
> Hi Randy,
>
>> [just documenting this for posterity or in case someone wants to fix it.]
>>
>> In drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c, one can find both
>>
>> struct amdgpu_vm_tlb_seq_cb {...};
>>
>> and
>> static void amdgpu_vm_tlb_seq_cb(...)
>>
>> Of course C has no problem with this, but kernel-doc reports:
>>
>> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:833: WARNING: Duplicate C declaration, also defined at gpu/amdgpu/driver-core:115.
>>
>> And of course, if the name of one of them is changed, kernel-doc is all happy...
>> not that I am suggesting that one of them should be changed.
>>
>> I just want to make people aware of this. (or maybe people are already aware of this?)
>
> The duplicate warning is emitted from Sphinx, not kernel-doc.
>
> This is a bug of Sphinx >=3.1, first reported by Mauro back in September 2020 at:
>
> https://github.com/sphinx-doc/sphinx/issues/8241
>
> It was closed when a local fix was presented. Unfortunately, it was not
> merged at the time and a subsequent pull request was opened at:
>
> https://github.com/sphinx-doc/sphinx/pull/8313
>
> It is not merged yet and carries a milestone of Sphinx 7.x.
>
> Looks like we need to wait patiently.
>
> Thanks, Akira
Ooooh, thanks for your assistance. Waiting.... :)
--
~Randy
next prev parent reply other threads:[~2023-07-12 3:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-12 2:37 Randy Dunlap
2023-07-12 3:32 ` Akira Yokosawa
2023-07-12 3:45 ` Randy Dunlap [this message]
2023-07-12 5:42 ` Mauro Carvalho Chehab
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=58cafdc0-0209-cfdd-c8e0-2dd25d73a184@infradead.org \
--to=rdunlap@infradead.org \
--cc=akiyks@gmail.com \
--cc=amd-gfx@lists.freedesktop.org \
--cc=corbet@lwn.net \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
/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
all inboxes | Powered by JetHome®