Commit caa93d9b authored by Fabio Estevam's avatar Fabio Estevam Committed by Greg Kroah-Hartman

usb: Fix up movement of USB core kerneldoc location

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: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarFabio Estevam <festevam@gmail.com>
Link: https://lore.kernel.org/r/20210424135103.2476670-1-festevam@gmail.comSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ddae7979
...@@ -109,15 +109,16 @@ well as to make sure they aren't relying on some HCD-specific behavior. ...@@ -109,15 +109,16 @@ well as to make sure they aren't relying on some HCD-specific behavior.
USB-Standard Types USB-Standard Types
================== ==================
In ``<linux/usb/ch9.h>`` you will find the USB data types defined in In ``drivers/usb/common/common.c`` and ``drivers/usb/common/debug.c`` you
chapter 9 of the USB specification. These data types are used throughout will find the USB data types defined in chapter 9 of the USB specification.
USB, and in APIs including this host side API, gadget APIs, usb character These data types are used throughout USB, and in APIs including this host
devices and debugfs interfaces. 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: :export:
.. _usb_header: .. kernel-doc:: drivers/usb/common/debug.c
:export:
Host-Side Data Types and Macros Host-Side Data Types and Macros
=============================== ===============================
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment