Linux USB
 help / color / mirror / Atom feed
From: Greg KH <gregkh@linuxfoundation.org>
To: Abhinav <singhabhinav9051571833@gmail.com>
Cc: stern@rowland.harvard.edu, benjamin.tissoires@redhat.com,
	mathias.nyman@linux.intel.com, hdegoede@redhat.com,
	hadess@hadess.net, linux-usb@vger.kernel.org,
	linux-kernel@vger.kernel.org, skhan@linuxfoundation.org
Subject: Re: [PATCH] fixed documentation warning about duplicate symbol
Date: Sat, 30 Sep 2023 15:31:42 +0200	[thread overview]
Message-ID: <2023093020-discern-dispersed-7dbe@gregkh> (raw)
In-Reply-To: <20230930123449.1170359-1-singhabhinav9051571833@gmail.com>

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?

thanks,

greg k-h

  reply	other threads:[~2023-09-30 13:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-30 12:34 [PATCH] fixed documentation warning about duplicate symbol Abhinav
2023-09-30 13:31 ` Greg KH [this message]
2023-09-30 16:42   ` Randy Dunlap
2023-09-30 15:30 ` kernel test robot

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=2023093020-discern-dispersed-7dbe@gregkh \
    --to=gregkh@linuxfoundation.org \
    --cc=benjamin.tissoires@redhat.com \
    --cc=hadess@hadess.net \
    --cc=hdegoede@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mathias.nyman@linux.intel.com \
    --cc=singhabhinav9051571833@gmail.com \
    --cc=skhan@linuxfoundation.org \
    --cc=stern@rowland.harvard.edu \
    /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