diff options
| author | Fabio Estevam <festevam@gmail.com> | 2021-04-24 10:51:03 -0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-04-24 16:01:09 +0200 |
| commit | caa93d9bd2d7ca7ffe5a23df9f003b81721c8e1b (patch) | |
| tree | 91b5532686fd7bcee26db3b70091c97a0d9396b7 /Documentation/driver-api/usb | |
| parent | ddae7979cdd5ed417f2b3ebdc5742e2a600b5ad5 (diff) | |
| download | linux-caa93d9bd2d7ca7ffe5a23df9f003b81721c8e1b.tar.gz linux-caa93d9bd2d7ca7ffe5a23df9f003b81721c8e1b.tar.bz2 linux-caa93d9bd2d7ca7ffe5a23df9f003b81721c8e1b.zip | |
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: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Fabio Estevam <festevam@gmail.com>
Link: https://lore.kernel.org/r/20210424135103.2476670-1-festevam@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api/usb')
| -rw-r--r-- | Documentation/driver-api/usb/usb.rst | 15 |
1 files 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 =============================== |