linux-kernel - Re: [PATCH] fixed documentation warning about duplicate symbol

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <a30164d2-a527-415a-b264-7f284a5266ab@infradead.org>
Date:   Sat, 30 Sep 2023 09:42:41 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Greg KH <gregkh@...uxfoundation.org>,
        Abhinav <singhabhinav9051571833@...il.com>
Cc:     stern@...land.harvard.edu, benjamin.tissoires@...hat.com,
        mathias.nyman@...ux.intel.com, hdegoede@...hat.com,
        hadess@...ess.net, linux-usb@...r.kernel.org,
        linux-kernel@...r.kernel.org, skhan@...uxfoundation.org
Subject: Re: [PATCH] fixed documentation warning about duplicate symbol



On 9/30/23 06:31, Greg KH wrote:
> On Sat, Sep 30, 2023 at 06:04:49PM +0530, Abhinav wrote:
>> Compiling the documentation in html gives a warning about duplicate symbol
>> because same name is used for function usb_string(...) and 
>> also for the struct usb_string.Also having a different name can
>> be helpful while searching or debugging the code.
>>
>> Renaming the function usb_string(...) to utf16le_to_utf8(...) fixes 
>> this warning.Reason for choosing this name because 
>> this is what the function description says it is doing.
> 
> Odd trailing spaces, why?
> 
> Anyway, sorry, but that's a horrible function name for a usb core
> function, especially just for a documentation warning?  Surely the
> documentation tools can determine the difference between a structure
> name and a function name?  This can't be the only place this has ever
> happened, right?
> 
> Try fixing the documentation tools instead?

Yes, this is a known Sphinx issue (i.e., not in scripts/kernel-doc).

There was an email thread about this on linux-doc last year:

https://lore.kernel.org/linux-doc/564cbd05-8788-9223-1ecc-59e7fc41b46a@gmail.com/

It looks like this particular issue has patch(es) available but they are
moving very slowly.

-- 
~Randy