linux-kernel - Re: [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file

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: <dfdf5685-30f6-4fad-f9e8-8605dce3668d@infradead.org>
Date:   Mon, 29 Mar 2021 11:15:50 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Aditya Srivastava <yashsri421@...il.com>,
        patrice.chotard@...s.st.com
Cc:     lukas.bulwahn@...il.com, balbi@...nel.org,
        gregkh@...uxfoundation.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        linux-usb@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in
 file

On 3/29/21 6:20 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/dwc3/dwc3-st.c follows this syntax, but the
> content inside does not comply with kernel-doc.
> 
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warning from kernel-doc:
> "warning: expecting prototype for dwc3(). Prototype was for CLKRST_CTRL() instead"
> 
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@...il.com>

Acked-by: Randy Dunlap <rdunlap@...radead.org>

> ---
> * Applies perfectly on next-20210326
> 
>  drivers/usb/dwc3/dwc3-st.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/dwc3/dwc3-st.c b/drivers/usb/dwc3/dwc3-st.c
> index b06b7092b1a2..166b5bde45cb 100644
> --- a/drivers/usb/dwc3/dwc3-st.c
> +++ b/drivers/usb/dwc3/dwc3-st.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0+
> -/**
> +/*
>   * dwc3-st.c Support for dwc3 platform devices on ST Microelectronics platforms
>   *
>   * This is a small driver for the dwc3 to provide the glue logic
> 


-- 
~Randy