The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: kevinpaul468@gmail.com
Cc: corbet@lwn.net, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, rbrasga@uci.edu,
	rdunlap@infradead.org, skhan@linuxfoundation.org,
	Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH] Added usb_string function to a namespace
Date: Sun, 6 Apr 2025 20:08:04 +0900	[thread overview]
Message-ID: <48bdc474-2dd8-4c51-a32f-04bc7e9f50e7@gmail.com> (raw)
In-Reply-To: <20250405165116.147958-1-kevinpaul468@gmail.com>

Hi,

Kevin Paul Reddy Janagari wrote:
> with reference to WARNING:
> Duplicate C declaration, also defined at driver-api/usb/gadget:804
> There is a function usb_string in the file message.c,
> there is also a struct usb_string in the kernel api headers.
> The docs is unable to index the function as the index is occupied by struct
> This fix adds messgae.c to the usb_core namespace (in docs) hence providing
> usb_sting a unique index usb_core.usb_string()

This is a bug of Sphinx.
Quote of my message in July 2023 [1]:

 > 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.

[1]: https://lore.kernel.org/0475d177-4c01-0988-0b34-3099dd703498@gmail.com/

The PR carries a milestone of Sphinx 8.x now ...

It might be a high time to make some noise in the PR.

       Thanks, Akira

> 
> Signed-off-by: Kevin Paul Reddy Janagari <kevinpaul468@gmail.com>
> ---
>  Documentation/driver-api/usb/usb.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
> index 89f9c37bb979..976fb4221062 100644
> --- a/Documentation/driver-api/usb/usb.rst
> +++ b/Documentation/driver-api/usb/usb.rst
> @@ -161,6 +161,7 @@ rely on 64bit DMA to eliminate another kind of bounce buffer.
>  .. kernel-doc:: drivers/usb/core/urb.c
>     :export:
>  
> +.. c:namespace:: usb_core
>  .. kernel-doc:: drivers/usb/core/message.c
>     :export:
>  
> -- 
> 2.39.5


  reply	other threads:[~2025-04-06 11:08 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-05 16:51 [PATCH] Added usb_string function to a namespace Kevin Paul Reddy Janagari
2025-04-06 11:08 ` Akira Yokosawa [this message]
2025-04-14 16:38 ` Jonathan Corbet

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=48bdc474-2dd8-4c51-a32f-04bc7e9f50e7@gmail.com \
    --to=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=kevinpaul468@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rbrasga@uci.edu \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.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