diff mbox series

usb: gadget: add doc to struct usb_composite_dev

Message ID Y9FmWVF+J08V4RbP@jo-einhundert
State New
Headers
Series usb: gadget: add doc to struct usb_composite_dev |

Commit Message

Jó Ágila Bitsch Jan. 25, 2023, 5:26 p.m. UTC 
  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(+)

Comments

Greg KH Jan. 25, 2023, 5:36 p.m. UTC | #1 
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
Greg KH Jan. 31, 2023, 11:51 a.m. UTC | #2 
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
diff mbox series

Patch

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