[PATCH v2] usb: Restore the reference to ch9.h

[PATCH v2] usb: Restore the reference to ch9.h

[Fabio Estevam]

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@rowland.harvard.edu>
Suggested-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Fabio Estevam <festevam@gmail.com>
---
Changes since v1:
- Incorporate Alan's feedback.

 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..2773cc3998fd 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 ``<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
+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
 ===============================
-- 
2.25.1

Re: [PATCH v2] usb: Restore the reference to ch9.h

[Alan Stern]

On Sat, Apr 24, 2021 at 01:34:30PM -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@rowland.harvard.edu>
> Suggested-by: Alan Stern <stern@rowland.harvard.edu>
> Signed-off-by: Fabio Estevam <festevam@gmail.com>
> ---
> Changes since v1:
> - Incorporate Alan's feedback.
> 
>  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..2773cc3998fd 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 ``<linux/usb/ch9.h>`` you will find the USB data types defined in
---------^

Should be uapi/linux/usb/ch9.h.  Otherwise okay.

Alan Stern

> +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
> +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
>  ===============================
> -- 
> 2.25.1
>