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

[Alan Stern <stern@rowland.harvard.edu>]

On Sat, Apr 24, 2021 at 12:48:23PM -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 ch9.h does not have any comments anymore, just remove the kernel-doc
> entries entirely.
> 
> Fixes: caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location")
> Reported-by: Alan Stern <stern@rowland.harvard.edu>
> Signed-off-by: Fabio Estevam <festevam@gmail.com>
> ---
> This one applies against usb-next.
> 
>  Documentation/driver-api/usb/usb.rst | 14 ++++----------
>  1 file changed, 4 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
> index 543e70434da2..251cab7cacd7 100644
> --- a/Documentation/driver-api/usb/usb.rst
> +++ b/Documentation/driver-api/usb/usb.rst
> @@ -109,16 +109,10 @@ 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.
> -
> -.. kernel-doc:: drivers/usb/common/common.c
> -   :export:
> -
> -.. kernel-doc:: drivers/usb/common/debug.c
> -   :export:
> +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.

I don't understand why you aren't giving a full description of the 
situation here.  You should say something more like this (edit to your 
taste):

In ``<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 
#include'd 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:

In addition, some functions useful for creating debugging output are 
defined in ``drivers/usb/common/debug.c``.

Alan Stern