From: Greg KH <gregkh@linuxfoundation.org>
To: Fabio Estevam <festevam@gmail.com>
Cc: chunfeng.yun@mediatek.com, sfr@canb.auug.org.au,
stern@rowland.harvard.edu, linux-usb@vger.kernel.org,
linux-next@vger.kernel.org, corbet@lwn.net,
linux-doc@vger.kernel.org
Subject: Re: [PATCH] usb: Fix up movement of USB core kerneldoc location
Date: Sat, 24 Apr 2021 16:00:55 +0200 [thread overview]
Message-ID: <YIQkl+rn3KuZtJOl@kroah.com> (raw)
In-Reply-To: <20210424135103.2476670-1-festevam@gmail.com>
On Sat, Apr 24, 2021 at 10:51:03AM -0300, Fabio Estevam wrote:
> Commit 855b35ea96c4 ("usb: common: move function's kerneldoc next to its
> definition") moved the USB common function documentation out of the
> linux/usb/ch9.h header file into drivers/usb/common/common.c and
> drivers/usb/common/debug.c, which causes the following 'make htmldocs'
> build warning:
>
> include/linux/usb/ch9.h:1: warning: no structured comments found
>
> Fix that up by pointing the documentation at the correct location.
>
> Fixes: 855b35ea96c4 ("usb: common: move function's kerneldoc next to its definition")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Fabio Estevam <festevam@gmail.com>
> ---
> Hi,
>
> I compared the generated HTML and now the following functions are
> also documented after this patch:
>
> usb_decode_interval()
> of_usb_get_dr_mode_by_phy()
> of_usb_host_tpl_support()
> of_usb_update_otg_caps()
> usb_of_get_companion_dev()
>
> They were not documented prior to 855b35ea96c4.
>
> Please let me know if this is OK or not.
Looks great, thank you for this, I'll go queue it up now!
greg k-h
next prev parent reply other threads:[~2021-04-24 14:01 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-24 13:51 [PATCH] usb: Fix up movement of USB core kerneldoc location Fabio Estevam
2021-04-24 14:00 ` Greg KH [this message]
2021-04-24 15:11 ` Alan Stern
2021-04-24 15:27 ` Fabio Estevam
-- strict thread matches above, loose matches on Subject: below --
2021-04-24 10:47 [PATCH] USB: fix " Greg Kroah-Hartman
2021-04-24 11:09 ` Greg Kroah-Hartman
2021-04-24 11:25 ` Fabio Estevam
2021-04-24 12:29 ` Fabio Estevam
2021-04-24 12:43 ` Greg Kroah-Hartman
2021-04-24 12:45 ` Fabio Estevam
2021-04-24 16:42 ` Randy Dunlap
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=YIQkl+rn3KuZtJOl@kroah.com \
--to=gregkh@linuxfoundation.org \
--cc=chunfeng.yun@mediatek.com \
--cc=corbet@lwn.net \
--cc=festevam@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
--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