Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2025-01-04 12:16:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

usb: Fix up movement of USB core kerneldoc location

Browse Source 
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>
This commit is contained in:
Fabio Estevam 2021-04-24 10:51:03 -03:00 committed by Greg Kroah-Hartman
parent ddae7979cd
commit caa93d9bd2
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/driver-api/usb/usb.rst
View File

@ -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
=============================== ===============================