Re: [PATCH] Added usb_string function to a namespace

From: Akira Yokosawa
Date: Sun Apr 06 2025 - 07:08:18 EST


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@xxxxxxxxx/

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@xxxxxxxxx>
> ---
> 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