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

Randy Dunlap
2021-03-15T22:34:10Z

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@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.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