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

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

 



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:

--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -114,9 +114,6 @@ 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:

Since ch9.h does not contain any structure/inline functions, it does
not contain any comment, so it should be just removed from the
kernel-doc section.

A similar issue has been fixed here:
https://patchwork.kernel.org/project/dri-devel/patch/20190920193558.89815-2-sean@xxxxxxxxxx/

Regards,

Fabio Estevam



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

  Powered by Linux