[PATCH 00/10] rsi: fix comment syntax in file headers

Kalle Valo kvalo at codeaurora.org
Mon Mar 15 08:41:30 UTC 2021

Lukas Bulwahn <lukas.bulwahn at gmail.com> writes:

> On Sun, Mar 14, 2021 at 9:18 PM Aditya Srivastava <yashsri421 at gmail.com> wrote:
>> The opening comment mark '/**' is used for highlighting the beginning of
>> kernel-doc comments.
>> There are 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 the kernel-doc like comment syntax with
>> general format, i.e. "/*", to prevent kernel-doc from parsing it.
> Aditya, thanks for starting to clean up the repository following your
> investigation on kernel-doc warnings.
> The changes to all those files look sound.
> However I think these ten patches are really just _one change_, and
> hence, all can be put into a single commit.

I agree, this is one logical change to a single driver so one patch will
suffice. I think for cleanup changes like this one patch per driver is a
good approach.



More information about the Linux-kernel-mentees mailing list