Messages in this thread | | | Date | Sat, 30 Sep 2023 09:42:41 -0700 | Subject | Re: [PATCH] fixed documentation warning about duplicate symbol | From | Randy Dunlap <> |
| |
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
| |