[PATCH] usb: Fix up movement of USB core kerneldoc location

From: Fabio Estevam <festevam@gmail.com>
To: gregkh@linuxfoundation.org
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, Fabio Estevam <festevam@gmail.com>
Subject: [PATCH] usb: Fix up movement of USB core kerneldoc location
Date: Sat, 24 Apr 2021 10:51:03 -0300	[thread overview]
Message-ID: <20210424135103.2476670-1-festevam@gmail.com> (raw)

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.

 Documentation/driver-api/usb/usb.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index 078e981e2b16..543e70434da2 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -109,15 +109,16 @@ well as to make sure they aren't relying on some HCD-specific behavior.
 USB-Standard Types
 ==================
 
-In ``<linux/usb/ch9.h>`` you will find the USB data types defined in
-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.
+In ``drivers/usb/common/common.c`` and ``drivers/usb/common/debug.c`` you
+will find the USB data types defined in 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
-   :internal:
+.. kernel-doc:: drivers/usb/common/common.c
+   :export:
 
-.. _usb_header:
+.. kernel-doc:: drivers/usb/common/debug.c
+   :export:
 
 Host-Side Data Types and Macros
 ===============================
-- 
2.25.1

