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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Apr 24, 2021 at 8:25 AM Fabio Estevam <festevam@xxxxxxxxx> wrote:
>
> Hi Greg,
>
> On Sat, Apr 24, 2021 at 8:10 AM Greg Kroah-Hartman
> <gregkh@xxxxxxxxxxxxxxxxxxx> 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?

Thanks



[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux