Re: [PATCH v2] rsi: fix comment syntax in file headers
From: Kalle Valo
Date: Sun Apr 18 2021 - 02:28:51 EST
Aditya Srivastava <yashsri421@xxxxxxxxx> 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@xxxxxxxxx>
> Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
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-yashsri421@xxxxxxxxx/
https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches