linux-kernel - Re: [PATCH 05/24] usb: dwc2: params: Fix naming of 'dwc2_get

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <ea2c0d51-2db2-7af7-92ce-b408d9381495@synopsys.com>
Date:   Wed, 26 May 2021 15:10:56 +0000
From:   Minas Harutyunyan <Minas.Harutyunyan@...opsys.com>
To:     Lee Jones <lee.jones@...aro.org>
CC:     "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "linux-usb@...r.kernel.org" <linux-usb@...r.kernel.org>
Subject: Re: [PATCH 05/24] usb: dwc2: params: Fix naming of
 'dwc2_get_hwparams()' in the docs

On 5/26/2021 5:00 PM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/usb/dwc2/params.c:787: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> 
> Cc: Minas Harutyunyan <hminas@...opsys.com>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: linux-usb@...r.kernel.org
> Signed-off-by: Lee Jones <lee.jones@...aro.org>


Acked-by: Minas Harutyunyan <Minas.Harutyunyan@...opsys.com>


> ---
>   drivers/usb/dwc2/params.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/usb/dwc2/params.c b/drivers/usb/dwc2/params.c
> index 7a6089fa81e1d..67c5eb1402325 100644
> --- a/drivers/usb/dwc2/params.c
> +++ b/drivers/usb/dwc2/params.c
> @@ -784,8 +784,8 @@ static void dwc2_get_dev_hwparams(struct dwc2_hsotg *hsotg)
>   }
>   
>   /**
> - * During device initialization, read various hardware configuration
> - * registers and interpret the contents.
> + * dwc2_get_hwparams() - During device initialization, read various hardware
> + *                       configuration registers and interpret the contents.
>    *
>    * @hsotg: Programming view of the DWC_otg controller
>    *
>