public inbox for linux-next@vger.kernel.org
 help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: linux-usb@vger.kernel.org
Cc: linux-next@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Chunfeng Yun <chunfeng.yun@mediatek.com>,
	Alan Stern <stern@rowland.harvard.edu>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH] USB: fix up movement of USB core kerneldoc location
Date: Sat, 24 Apr 2021 12:47:15 +0200	[thread overview]
Message-ID: <20210424104715.2793760-1-gregkh@linuxfoundation.org> (raw)

Commit 855b35ea96c4 ("usb: common: move function's kerneldoc next to its
definition") moved the USB common function documentation out of the .h
file and into the .c file.  But, we forgot to tell the Documentation
where the new information is at, resulting in a build warning of:
	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")
Cc: Chunfeng Yun <chunfeng.yun@mediatek.com>
Cc: Alan Stern <stern@rowland.harvard.edu>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 Documentation/driver-api/usb/usb.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index 078e981e2b16..c08b92558dcb 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -114,7 +114,7 @@ chapter 9 of the USB specification. These data types are used throughout
 USB, and in APIs including this host side API, gadget APIs, usb character
 devices and debugfs interfaces.
 
-.. kernel-doc:: include/linux/usb/ch9.h
+.. kernel-doc:: drivers/usb/common/common.c
    :internal:
 
 .. _usb_header:
-- 
2.31.1


             reply	other threads:[~2021-04-24 10:47 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-24 10:47 Greg Kroah-Hartman [this message]
2021-04-24 11:09 ` [PATCH] USB: fix up movement of USB core kerneldoc location 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
  -- strict thread matches above, loose matches on Subject: below --
2021-04-24 13:51 [PATCH] usb: Fix " Fabio Estevam
2021-04-24 14:00 ` Greg KH
2021-04-24 15:11 ` Alan Stern
2021-04-24 15:27   ` Fabio Estevam

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=20210424104715.2793760-1-gregkh@linuxfoundation.org \
    --to=gregkh@linuxfoundation.org \
    --cc=chunfeng.yun@mediatek.com \
    --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