* linux-next: build warning after merge of the usb tree
@ 2023-01-23 4:24 Stephen Rothwell
2023-01-23 14:42 ` Greg KH
0 siblings, 1 reply; 9+ messages in thread
From: Stephen Rothwell @ 2023-01-23 4:24 UTC (permalink / raw)
To: Greg KH
Cc: Greg Kroah-Hartman, Jó Ágila Bitsch,
Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 743 bytes --]
Hi all,
After merging the usb tree, today's linux-next build (htmldocs) produced
this warning:
include/linux/usb/composite.h:510: warning: Function parameter or member 'bcd_webusb_version' not described in 'usb_composite_dev'
include/linux/usb/composite.h:510: warning: Function parameter or member 'b_webusb_vendor_code' not described in 'usb_composite_dev'
include/linux/usb/composite.h:510: warning: Function parameter or member 'landing_page' not described in 'usb_composite_dev'
include/linux/usb/composite.h:510: warning: Function parameter or member 'use_webusb' not described in 'usb_composite_dev'
Introduced by commit
93c473948c58 ("usb: gadget: add WebUSB landing page support")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: linux-next: build warning after merge of the usb tree
2023-01-23 4:24 linux-next: build warning after merge of the usb tree Stephen Rothwell
@ 2023-01-23 14:42 ` Greg KH
2023-01-25 17:01 ` Jó Ágila Bitsch
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
0 siblings, 2 replies; 9+ messages in thread
From: Greg KH @ 2023-01-23 14:42 UTC (permalink / raw)
To: Stephen Rothwell, Jó Ágila Bitsch
Cc: Linux Kernel Mailing List, Linux Next Mailing List
On Mon, Jan 23, 2023 at 03:24:30PM +1100, Stephen Rothwell wrote:
> Hi all,
>
> After merging the usb tree, today's linux-next build (htmldocs) produced
> this warning:
>
> include/linux/usb/composite.h:510: warning: Function parameter or member 'bcd_webusb_version' not described in 'usb_composite_dev'
> include/linux/usb/composite.h:510: warning: Function parameter or member 'b_webusb_vendor_code' not described in 'usb_composite_dev'
> include/linux/usb/composite.h:510: warning: Function parameter or member 'landing_page' not described in 'usb_composite_dev'
> include/linux/usb/composite.h:510: warning: Function parameter or member 'use_webusb' not described in 'usb_composite_dev'
>
> Introduced by commit
>
> 93c473948c58 ("usb: gadget: add WebUSB landing page support")
Jó, can you send a follow-on patch to fix this issue please?
thanks,
greg k-h
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: linux-next: build warning after merge of the usb tree
2023-01-23 14:42 ` Greg KH
@ 2023-01-25 17:01 ` Jó Ágila Bitsch
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
1 sibling, 0 replies; 9+ messages in thread
From: Jó Ágila Bitsch @ 2023-01-25 17:01 UTC (permalink / raw)
To: Greg KH
Cc: Stephen Rothwell, Linux Kernel Mailing List, Linux Next Mailing List
On Mon, Jan 23, 2023 at 3:42 PM Greg KH <greg@kroah.com> wrote:
>
> On Mon, Jan 23, 2023 at 03:24:30PM +1100, Stephen Rothwell wrote:
> > Hi all,
> >
> > After merging the usb tree, today's linux-next build (htmldocs) produced
> > this warning:
> >
> > include/linux/usb/composite.h:510: warning: Function parameter or member 'bcd_webusb_version' not described in 'usb_composite_dev'
> > include/linux/usb/composite.h:510: warning: Function parameter or member 'b_webusb_vendor_code' not described in 'usb_composite_dev'
> > include/linux/usb/composite.h:510: warning: Function parameter or member 'landing_page' not described in 'usb_composite_dev'
> > include/linux/usb/composite.h:510: warning: Function parameter or member 'use_webusb' not described in 'usb_composite_dev'
> >
> > Introduced by commit
> >
> > 93c473948c58 ("usb: gadget: add WebUSB landing page support")
>
> Jó, can you send a follow-on patch to fix this issue please?
>
> thanks,
>
> greg k-h
I just posted a new version where I also merged in Andy Shevchenko's
patches against by patch.
Best regards,
Jó
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH] usb: gadget: add doc to struct usb_composite_dev
2023-01-23 14:42 ` Greg KH
2023-01-25 17:01 ` Jó Ágila Bitsch
@ 2023-01-25 17:26 ` Jó Ágila Bitsch
2023-01-25 17:36 ` Greg KH
` (2 more replies)
1 sibling, 3 replies; 9+ messages in thread
From: Jó Ágila Bitsch @ 2023-01-25 17:26 UTC (permalink / raw)
To: Greg KH, Stephen Rothwell, Linux Kernel Mailing List,
Linux Next Mailing List
Added documentation to the new struct members:
* bcd_webusb_version
* b_webusb_vendor_code
* landing_page
* use_webusb
to avoid warnings in the build of htmldocs
Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
---
include/linux/usb/composite.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 91d22c3ed458..7ef8cea67f50 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
* @qw_sign: qwSignature part of the OS string
* @b_vendor_code: bMS_VendorCode part of the OS string
* @use_os_string: false by default, interested gadgets set it
+ * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
+ * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
+ * @landing_page: empty by default, landing page to announce in WebUSB
+ * @use_webusb:: false by default, interested gadgets set it
* @os_desc_config: the configuration to be used with OS descriptors
* @setup_pending: true when setup request is queued but not completed
* @os_desc_pending: true when os_desc request is queued but not completed
--
2.37.2
^ permalink raw reply related [flat|nested] 9+ messages in thread* Re: [PATCH] usb: gadget: add doc to struct usb_composite_dev
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
@ 2023-01-25 17:36 ` Greg KH
2023-01-25 21:33 ` [PATCH v1] " Jó Ágila Bitsch
2023-01-31 11:51 ` [PATCH] " Greg KH
2 siblings, 0 replies; 9+ messages in thread
From: Greg KH @ 2023-01-25 17:36 UTC (permalink / raw)
To: Jó Ágila Bitsch
Cc: Stephen Rothwell, Linux Kernel Mailing List, Linux Next Mailing List
On Wed, Jan 25, 2023 at 06:26:49PM +0100, Jó Ágila Bitsch wrote:
> Added documentation to the new struct members:
> * bcd_webusb_version
> * b_webusb_vendor_code
> * landing_page
> * use_webusb
> to avoid warnings in the build of htmldocs
>
> Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
What commit id does this fix?
And it was reported by Stephen, so can you provide a reported-by tag
too?
thanks,
greg k-h
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v1] usb: gadget: add doc to struct usb_composite_dev
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
2023-01-25 17:36 ` Greg KH
@ 2023-01-25 21:33 ` Jó Ágila Bitsch
2023-01-31 11:51 ` [PATCH] " Greg KH
2 siblings, 0 replies; 9+ messages in thread
From: Jó Ágila Bitsch @ 2023-01-25 21:33 UTC (permalink / raw)
To: Greg KH, Stephen Rothwell, Linux Kernel Mailing List,
Linux Next Mailing List
Added documentation to new struct members for WebUSB:
* bcd_webusb_version
* b_webusb_vendor_code
* landing_page
* use_webusb
to avoid warnings in the build of htmldocs
Fixes: 93c473948c58 ("usb: gadget: add WebUSB landing page support")
Reported-By: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
---
V0 -> V1: added Tested-By and Fixes Tags
include/linux/usb/composite.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 91d22c3ed458..7ef8cea67f50 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
* @qw_sign: qwSignature part of the OS string
* @b_vendor_code: bMS_VendorCode part of the OS string
* @use_os_string: false by default, interested gadgets set it
+ * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
+ * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
+ * @landing_page: empty by default, landing page to announce in WebUSB
+ * @use_webusb:: false by default, interested gadgets set it
* @os_desc_config: the configuration to be used with OS descriptors
* @setup_pending: true when setup request is queued but not completed
* @os_desc_pending: true when os_desc request is queued but not completed
--
2.37.2
^ permalink raw reply related [flat|nested] 9+ messages in thread* Re: [PATCH] usb: gadget: add doc to struct usb_composite_dev
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
2023-01-25 17:36 ` Greg KH
2023-01-25 21:33 ` [PATCH v1] " Jó Ágila Bitsch
@ 2023-01-31 11:51 ` Greg KH
2023-02-04 12:15 ` [PATCH v2] " Jó Ágila Bitsch
2 siblings, 1 reply; 9+ messages in thread
From: Greg KH @ 2023-01-31 11:51 UTC (permalink / raw)
To: Jó Ágila Bitsch
Cc: Stephen Rothwell, Linux Kernel Mailing List, Linux Next Mailing List
On Wed, Jan 25, 2023 at 06:26:49PM +0100, Jó Ágila Bitsch wrote:
> Added documentation to the new struct members:
> * bcd_webusb_version
> * b_webusb_vendor_code
> * landing_page
> * use_webusb
> to avoid warnings in the build of htmldocs
>
> Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
You forgot a Reported-by: tag?
Also didn't cc: the linux-usb mailing list?
please fix up and send v2.
thanks,
greg k-h
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v2] usb: gadget: add doc to struct usb_composite_dev
2023-01-31 11:51 ` [PATCH] " Greg KH
@ 2023-02-04 12:15 ` Jó Ágila Bitsch
2023-04-12 23:11 ` Randy Dunlap
0 siblings, 1 reply; 9+ messages in thread
From: Jó Ágila Bitsch @ 2023-02-04 12:15 UTC (permalink / raw)
To: Greg KH, Stephen Rothwell, Linux Kernel Mailing List,
Linux Next Mailing List, linux-usb
Added documentation to new struct members for WebUSB:
* bcd_webusb_version
* b_webusb_vendor_code
* landing_page
* use_webusb
to avoid warnings in the build of htmldocs
Fixes: 93c473948c58 ("usb: gadget: add WebUSB landing page support")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
---
V0 -> V1: added Reported-By and Fixes Tags
V1 -> V2: fixed Reported-by tag (capitalization of "-by" was wrong)
also post to linux-usb
include/linux/usb/composite.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 91d22c3ed458..7ef8cea67f50 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
* @qw_sign: qwSignature part of the OS string
* @b_vendor_code: bMS_VendorCode part of the OS string
* @use_os_string: false by default, interested gadgets set it
+ * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
+ * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
+ * @landing_page: empty by default, landing page to announce in WebUSB
+ * @use_webusb:: false by default, interested gadgets set it
* @os_desc_config: the configuration to be used with OS descriptors
* @setup_pending: true when setup request is queued but not completed
* @os_desc_pending: true when os_desc request is queued but not completed
--
2.37.2
^ permalink raw reply related [flat|nested] 9+ messages in thread* Re: [PATCH v2] usb: gadget: add doc to struct usb_composite_dev
2023-02-04 12:15 ` [PATCH v2] " Jó Ágila Bitsch
@ 2023-04-12 23:11 ` Randy Dunlap
0 siblings, 0 replies; 9+ messages in thread
From: Randy Dunlap @ 2023-04-12 23:11 UTC (permalink / raw)
To: Jó Ágila Bitsch, Greg KH, Stephen Rothwell,
Linux Kernel Mailing List, Linux Next Mailing List, linux-usb
Hi,
On 2/4/23 04:15, Jó Ágila Bitsch wrote:
> Added documentation to new struct members for WebUSB:
> * bcd_webusb_version
> * b_webusb_vendor_code
> * landing_page
> * use_webusb
> to avoid warnings in the build of htmldocs
>
> Fixes: 93c473948c58 ("usb: gadget: add WebUSB landing page support")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Jó Ágila Bitsch <jgilab@gmail.com>
> ---
> V0 -> V1: added Reported-By and Fixes Tags
> V1 -> V2: fixed Reported-by tag (capitalization of "-by" was wrong)
> also post to linux-usb
>
> include/linux/usb/composite.h | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
> index 91d22c3ed458..7ef8cea67f50 100644
> --- a/include/linux/usb/composite.h
> +++ b/include/linux/usb/composite.h
> @@ -432,6 +432,10 @@ static inline struct usb_composite_driver *to_cdriver(
> * @qw_sign: qwSignature part of the OS string
> * @b_vendor_code: bMS_VendorCode part of the OS string
> * @use_os_string: false by default, interested gadgets set it
> + * @bcd_webusb_version: 0x0100 by default, WebUSB specification version
> + * @b_webusb_vendor_code: 0x0 by default, vendor code for WebUSB
> + * @landing_page: empty by default, landing page to announce in WebUSB
> + * @use_webusb:: false by default, interested gadgets set it
Please drop one ':' above so that kernel-doc does not complain:
include/linux/usb/composite.h:523: warning: Function parameter or member 'use_webusb' not described in 'usb_composite_dev'
> * @os_desc_config: the configuration to be used with OS descriptors
> * @setup_pending: true when setup request is queued but not completed
> * @os_desc_pending: true when os_desc request is queued but not completed
Thanks.
--
~Randy
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2023-04-12 23:11 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-23 4:24 linux-next: build warning after merge of the usb tree Stephen Rothwell
2023-01-23 14:42 ` Greg KH
2023-01-25 17:01 ` Jó Ágila Bitsch
2023-01-25 17:26 ` [PATCH] usb: gadget: add doc to struct usb_composite_dev Jó Ágila Bitsch
2023-01-25 17:36 ` Greg KH
2023-01-25 21:33 ` [PATCH v1] " Jó Ágila Bitsch
2023-01-31 11:51 ` [PATCH] " Greg KH
2023-02-04 12:15 ` [PATCH v2] " Jó Ágila Bitsch
2023-04-12 23:11 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).