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

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

 



Hi Alan,

On Sat, Apr 24, 2021 at 12:11 PM Alan Stern <stern@xxxxxxxxxxxxxxxxxxx> wrote:

> This is quite wrong.
>
> The USB data types defined in chapter 9 of the USB specification can
> actually be found in include/uapi/linux/usb/ch9.h.  What
> drivers/usb/common/common.c contains is the definitions of the functions
> declared in include/linux/usb/ch9.h, which is a different file (although
> it does #include the file in include/uapi/linux/usb/).

It seems we can no longer refer include/linux/usb/ch9.h inside the
kerneldoc marker, as this file does not contain any comments anymore.

Would this change on top of this patch be OK?

Thanks

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.

 Host-Side Data Types and Macros
 ===============================
-- 
2.25.1



[Index of Archives]     [Linux Kernel]     [Linux USB Development]     [Yosemite News]     [Linux SCSI]

  Powered by Linux