linux-kernel - Re: [PATCH v2] rsi: fix comment syntax in file headers

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: <dd3c5da5-ec8e-1354-3ab9-bf4c4f90a378@infradead.org>
Date:   Mon, 15 Mar 2021 15:32:49 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Aditya Srivastava <yashsri421@...il.com>, kvalo@...eaurora.org
Cc:     lukas.bulwahn@...il.com,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        amitkarwar@...il.com, siva8118@...il.com, davem@...emloft.net,
        kuba@...nel.org, linux-wireless@...r.kernel.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] rsi: fix comment syntax in file headers

On 3/15/21 10:32 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> There are some files in drivers/net/wireless/rsi which follow this syntax
> in their file headers, i.e. start with '/**' like comments, which causes
> unexpected warnings from kernel-doc.
> 
> E.g., running scripts/kernel-doc -none on drivers/net/wireless/rsi/rsi_coex.h
> causes this warning:
> "warning: wrong kernel-doc identifier on line:
>  * Copyright (c) 2018 Redpine Signals Inc."
> 
> Similarly for other files too.
> 
> Provide a simple fix by replacing such occurrences with general comment
> format, i.e., "/*", to prevent kernel-doc from parsing it.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@...il.com>

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

Thanks.

> ---
> - Applies perfectly on next-20210312
> 
> Changes in v2:
> - Convert the patch series to a single patch as suggested by Lukas and Kalle
> 
>  drivers/net/wireless/rsi/rsi_boot_params.h | 2 +-
>  drivers/net/wireless/rsi/rsi_coex.h        | 2 +-
>  drivers/net/wireless/rsi/rsi_common.h      | 2 +-
>  drivers/net/wireless/rsi/rsi_debugfs.h     | 2 +-
>  drivers/net/wireless/rsi/rsi_hal.h         | 2 +-
>  drivers/net/wireless/rsi/rsi_main.h        | 2 +-
>  drivers/net/wireless/rsi/rsi_mgmt.h        | 2 +-
>  drivers/net/wireless/rsi/rsi_ps.h          | 2 +-
>  drivers/net/wireless/rsi/rsi_sdio.h        | 2 +-
>  drivers/net/wireless/rsi/rsi_usb.h         | 2 +-
>  10 files changed, 10 insertions(+), 10 deletions(-)
> 


-- 
~Randy