linux-kernel - Re: [PATCH] usb: cdns3: Corrected comment to align with kernel-doc comment

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]

Message-ID: <6aeb87ba-4a45-909a-65e4-370cc193f8db@infradead.org>
Date:   Sat, 24 Apr 2021 08:53:19 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Souptick Joarder <jrdr.linux@...il.com>, peter.chen@...nel.org,
        pawell@...ence.com, rogerq@...nel.org, a-govindraju@...com,
        gregkh@...uxfoundation.org
Cc:     linux-usb@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] usb: cdns3: Corrected comment to align with kernel-doc
 comment

On 4/24/21 4:30 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> 
> drivers/usb/cdns3/cdns3-gadget.c:487: warning: This comment starts with
> '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> This patch will silence the warning.
> 
> Reported-by: kernel test robot <lkp@...el.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@...il.com>
> ---
>  drivers/usb/cdns3/cdns3-gadget.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
> index 9b1bd41..0280a38 100644
> --- a/drivers/usb/cdns3/cdns3-gadget.c
> +++ b/drivers/usb/cdns3/cdns3-gadget.c
> @@ -483,7 +483,7 @@ static void __cdns3_descmiss_copy_data(struct usb_request *request,
>  	}
>  }
>  
> -/**
> +/*
>   * cdns3_wa2_descmiss_copy_data copy data from internal requests to

Please just insert a hyphen/dash between the function name and its description.

>   * request queued by class driver.
>   * @priv_ep: extended endpoint object
> 

thanks.
-- 
~Randy