linux-kernel - Re: [PATCH v2] usb: gadget: add doc to struct usb_composite

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Wed, 12 Apr 2023 16:11:25 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jó Ágila Bitsch <jgilab@...il.com>,
        Greg KH <greg@...ah.com>,
        Stephen Rothwell <sfr@...b.auug.org.au>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Next Mailing List <linux-next@...r.kernel.org>,
        linux-usb@...r.kernel.org
Subject: Re: [PATCH v2] usb: gadget: add doc to struct usb_composite_dev

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@...b.auug.org.au>
> Signed-off-by: Jó Ágila Bitsch <jgilab@...il.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