linux-kernel - Re: [PATCH] usb:dwc:core.h Fixed warning of documentation

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 for Android: free password hash cracker in your pocket

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

Message-ID: <22e509fc-e250-29b3-e9f1-d62a6d10ec60@infradead.org>
Date:   Tue, 28 Mar 2023 20:36:39 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Piyush Thange <pthange19@...il.com>, Thinh.Nguyen@...opsys.com,
        gregkh@...uxfoundation.org, linux-usb@...r.kernel.org,
        linux-kernel@...r.kernel.org
Cc:     linux-kernel-mentees@...ts.linuxfoundation.org, shuah@...nel.org
Subject: Re: [PATCH] usb:dwc:core.h Fixed warning of documentation

Hi--

On 3/28/23 20:29, Piyush Thange wrote:
> While compiling documentation a following warning is generated.
> Function parameter or member 'resume_hs_terminations' not described 
> in 'dwc3'

This one appears to be fixed already.

> One more warning arises in the same file as follows
> Function parameter or member 'gfladj_refclk_lpm_sel' not described 
> in 'dwc3'
> 
> I need some insights on this.

The second one needs a line added, probably just after:

 * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
 *			instances in park mode.

like

 * @gfladj_refclk_lpm_sel: {some description here}

Thanks.

> Signed-off-by: Piyush Thange <pthange19@...il.com>
> ---
>  drivers/usb/dwc3/core.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index 582ebd9cf9c2..4743e918dcaf 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -1098,7 +1098,7 @@ struct dwc3_scratchpad_array {
>   *			change quirk.
>   * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
>   *			check during HS transmit.
> - * @resume-hs-terminations: Set if we enable quirk for fixing improper crc
> + * @resume_hs_terminations: Set if we enable quirk for fixing improper crc
>   *			generation after resume from suspend.
>   * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
>   *			instances in park mode.

-- 
~Randy