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

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

[Fabio Estevam]

Commit 855b35ea96c4 ("usb: common: move function's kerneldoc next to its
definition") moved the USB common function documentation out of the
linux/usb/ch9.h header file into drivers/usb/common/common.c and
drivers/usb/common/debug.c, which causes the following 'make htmldocs'
build warning:

include/linux/usb/ch9.h:1: warning: no structured comments found

Fix that up by pointing the documentation at the correct location.

Fixes: 855b35ea96c4 ("usb: common: move function's kerneldoc next to its definition")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Fabio Estevam <festevam@gmail.com>
---
Hi,

I compared the generated HTML and now the following functions are
also documented after this patch:

usb_decode_interval()
of_usb_get_dr_mode_by_phy()
of_usb_host_tpl_support()
of_usb_update_otg_caps()
usb_of_get_companion_dev()

They were not documented prior to 855b35ea96c4.

Please let me know if this is OK or not.

 Documentation/driver-api/usb/usb.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index 078e981e2b16..543e70434da2 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -109,15 +109,16 @@ 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
-USB, and in APIs including this host side API, gadget APIs, usb character
-devices and debugfs interfaces.
+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:: include/linux/usb/ch9.h
-   :internal:
+.. kernel-doc:: drivers/usb/common/common.c
+   :export:
 
-.. _usb_header:
+.. kernel-doc:: drivers/usb/common/debug.c
+   :export:
 
 Host-Side Data Types and Macros
 ===============================
-- 
2.25.1

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

[Greg KH]

On Sat, Apr 24, 2021 at 10:51:03AM -0300, Fabio Estevam wrote:
> Commit 855b35ea96c4 ("usb: common: move function's kerneldoc next to its
> definition") moved the USB common function documentation out of the
> linux/usb/ch9.h header file into drivers/usb/common/common.c and
> drivers/usb/common/debug.c, which causes the following 'make htmldocs'
> build warning:
> 
> include/linux/usb/ch9.h:1: warning: no structured comments found
> 
> Fix that up by pointing the documentation at the correct location.
> 
> Fixes: 855b35ea96c4 ("usb: common: move function's kerneldoc next to its definition")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Fabio Estevam <festevam@gmail.com>
> ---
> Hi,
> 
> I compared the generated HTML and now the following functions are
> also documented after this patch:
> 
> usb_decode_interval()
> of_usb_get_dr_mode_by_phy()
> of_usb_host_tpl_support()
> of_usb_update_otg_caps()
> usb_of_get_companion_dev()
> 
> They were not documented prior to 855b35ea96c4.
> 
> Please let me know if this is OK or not.

Looks great, thank you for this, I'll go queue it up now!

greg k-h

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

[Alan Stern]

On Sat, Apr 24, 2021 at 10:51:03AM -0300, Fabio Estevam wrote:
> Commit 855b35ea96c4 ("usb: common: move function's kerneldoc next to its
> definition") moved the USB common function documentation out of the
> linux/usb/ch9.h header file into drivers/usb/common/common.c and
> drivers/usb/common/debug.c, which causes the following 'make htmldocs'
> build warning:
> 
> include/linux/usb/ch9.h:1: warning: no structured comments found
> 
> Fix that up by pointing the documentation at the correct location.
> 
> Fixes: 855b35ea96c4 ("usb: common: move function's kerneldoc next to its definition")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Fabio Estevam <festevam@gmail.com>
> ---
> Hi,
> 
> I compared the generated HTML and now the following functions are
> also documented after this patch:
> 
> usb_decode_interval()
> of_usb_get_dr_mode_by_phy()
> of_usb_host_tpl_support()
> of_usb_update_otg_caps()
> usb_of_get_companion_dev()
> 
> They were not documented prior to 855b35ea96c4.
> 
> Please let me know if this is OK or not.
> 
>  Documentation/driver-api/usb/usb.rst | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
> index 078e981e2b16..543e70434da2 100644
> --- a/Documentation/driver-api/usb/usb.rst
> +++ b/Documentation/driver-api/usb/usb.rst
> @@ -109,15 +109,16 @@ 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
> -USB, and in APIs including this host side API, gadget APIs, usb character
> -devices and debugfs interfaces.
> +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.

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/).

drivers/usb/common/debug.c, on the other hand, contains definitions of 
various functions used for debugging output.  If those functions are 
declared in a header file anywhere, I can't see it.

Alan Stern

> -.. kernel-doc:: include/linux/usb/ch9.h
> -   :internal:
> +.. kernel-doc:: drivers/usb/common/common.c
> +   :export:
>  
> -.. _usb_header:
> +.. kernel-doc:: drivers/usb/common/debug.c
> +   :export:
>  
>  Host-Side Data Types and Macros
>  ===============================
> -- 
> 2.25.1
> 

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

[Fabio Estevam]

Hi Alan,

On Sat, Apr 24, 2021 at 12:11 PM Alan Stern <stern@rowland.harvard.edu> 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