On Sun, Apr 25, 2021 at 10:13:43AM -0300, Fabio Estevam wrote:
> Keep the textual reference to ch9.h as it was prior to commit
> caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location").
>
> As linux/usb/ch9.h does not contain comments anymore, explain
> that drivers/usb/common/common.c includes such header and provides
> declarations of a few utilities routines for manipulating the data types
> from ch9.h. Also mention that drivers/usb/common/debug.c contains
> some functions for creating debug output.
>
> Fixes: caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location")
> Reported-by: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
> Suggested-by: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
> Signed-off-by: Fabio Estevam <festevam@xxxxxxxxx>
> ---
> Changes since v2:
> - Refer to include/uapi/linux/usb/ch9.h initially (Alan)
>
> Documentation/driver-api/usb/usb.rst | 15 +++++++++------
> 1 file changed, 9 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
> index 543e70434da2..e97a46461884 100644
> --- a/Documentation/driver-api/usb/usb.rst
> +++ b/Documentation/driver-api/usb/usb.rst
> @@ -109,16 +109,19 @@ well as to make sure they aren't relying on some HCD-specific behavior.
> USB-Standard Types
> ==================
>
> -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.
> +In ``include/uapi/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. That file is itself included by
> +``<linux/usb/ch9.h>``, which also contains declarations of a few utility
Should this be ``include/linux/usb/ch9.h``, with the "include/" and
without the "<...>"? We seem to be inconsistent in the way we refer to
include files. This was true of the original document as well.
> +routines for manipulating these data types; the implementations are
> +in ``drivers/usb/common/common.c``.
>
> .. kernel-doc:: drivers/usb/common/common.c
> :export:
>
> -.. kernel-doc:: drivers/usb/common/debug.c
> - :export:
> +In addition, some functions useful for creating debugging output are
> +defined in ``drivers/usb/common/debug.c``.
>
> Host-Side Data Types and Macros
> ===============================
Better now.
Acked-by: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
Alan Stern
