Re: [PATCH] USB: fix up movement of USB core kerneldoc location

[Greg Kroah-Hartman <gregkh@linuxfoundation.org>]

On Sat, Apr 24, 2021 at 09:29:00AM -0300, Fabio Estevam wrote:
> On Sat, Apr 24, 2021 at 8:25 AM Fabio Estevam <festevam@gmail.com> wrote:
> >
> > Hi Greg,
> >
> > On Sat, Apr 24, 2021 at 8:10 AM Greg Kroah-Hartman
> > <gregkh@linuxfoundation.org> wrote:
> >
> > > Wait, no, now I see the warning:
> > >         ./drivers/usb/common/common.c:1: warning: no structured comments found
> > > instead.
> > >
> > > Is that expected?  It doesn't feel right to me, what should we be doing
> > > instead?
> >
> > I think we should do like this instead:
> 
> Actually I think the fix should be like this:
> 
> diff --git a/Documentation/driver-api/usb/usb.rst
> b/Documentation/driver-api/usb/usb.rst
> index 078e981e2b16..cbc76fb51aa9 100644
> --- a/Documentation/driver-api/usb/usb.rst
> +++ b/Documentation/driver-api/usb/usb.rst
> @@ -109,15 +109,13 @@ 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
> +In ``drivers/usb/common/common.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:
> -
> -.. _usb_header:
> +.. kernel-doc:: drivers/usb/common/common.c
> +   :export:
> 
>  Host-Side Data Types and Macros
>  ===============================
> 
> Does this look good?

Does that produce the same output with the information from those
functions?  If so, yes, that's fine, I didn't understand the need for
_usb_header: there at all...

Can you resend this as a real patch?

thanks,

greg k-h