public inbox for linux-next@vger.kernel.org
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: greg@kroah.com, sfr@canb.auug.org.au
Cc: corbet@lwn.net, linux-kernel@vger.kernel.org, linux-next@vger.kernel.org
Subject: Re: linux-next: build warning for a long time
Date: Fri, 11 Oct 2024 15:51:05 +0900	[thread overview]
Message-ID: <b58f2c3b-382f-46ce-b2b8-fb39a5c3b356@gmail.com> (raw)
In-Reply-To: <2024101127-scrubbed-unfilled-8b47@gregkh>

Hi,

Sorry for the premature reply I just sent...

On Fri, 11 Oct 2024 08:31:47 +0200, Greg KH wrote:
> On Fri, Oct 11, 2024 at 05:24:42PM +1100, Stephen Rothwell wrote:
>> Hi all,
>> 
>> From before the git era, an htmldocs build (if we had such a thing back
>> then) would complain like this:
>> 
>> Documentation/driver-api/usb/usb:164: drivers/usb/core/message.c:968: WARNING: Duplicate C declaration, also defined at driver-api/usb/gadget:804.
>> Declaration is '.. c:function:: int usb_string (struct usb_device *dev, int index, char *buf, size_t size)'.
>> 
>> I assume it is confused because we have documented both a function and a
>> data type called "usb_string".  The former in drivers/usb/core/message.c
>> and the latter in include/linux/usb/gadget.h.
>> 
>> There are about 46 references to the function and 105 to the struct.
>> We could rename the function to usb_string_utf8 ...
> 
> But usb strings are not in utf8 format :)
> 
> As C can handle this just fine, odds are sphinx should also be able to
> handle this?
> 
> thanks,

This is a well known issue of Sphinx, which is taking a looong time to be
properly fixed.

For your info, this is a short summary I posted last March:

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

I think we need to wait patiently for a fix(es) of Sphinx.

HTH,

Akira


      parent reply	other threads:[~2024-10-11  6:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11  6:24 linux-next: build warning for a long time Stephen Rothwell
2024-10-11  6:31 ` Greg KH
2024-10-11  6:38   ` Akira Yokosawa
2024-10-11  6:51   ` 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=b58f2c3b-382f-46ce-b2b8-fb39a5c3b356@gmail.com \
    --to=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=greg@kroah.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /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