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

[Kalle Valo]

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 
> Reviewed-by: Randy Dunlap 

Patch applied to wireless-drivers-next.git, thanks.

3051946056c3 rsi: fix comment syntax in file headers

-- 
https://patchwork.kernel.org/project/linux-wireless/patch/20210315173259.8757-1-yashsri...@gmail.com/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

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

[Randy Dunlap]

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 

Reviewed-by: Randy Dunlap 

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