All of lore.kernel.org
 help / color / mirror / Atom feed
From: Kalle Valo <kvalo@codeaurora.org>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>,
	Netdev <netdev@vger.kernel.org>,
	linux-wireless <linux-wireless@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	amitkarwar@gmail.com, siva8118@gmail.com,
	Jakub Kicinski <kuba@kernel.org>,
	linux-kernel-mentees@lists.linuxfoundation.org,
	David Miller <davem@davemloft.net>
Subject: Re: [PATCH 00/10] rsi: fix comment syntax in file headers
Date: Mon, 15 Mar 2021 10:41:30 +0200	[thread overview]
Message-ID: <87a6r4u7ut.fsf@codeaurora.org> (raw)
In-Reply-To: <CAKXUXMzH-cUVeuCT6eM_0iHzgKpzvZUPO6pKNpD0yUp2td09Ug@mail.gmail.com> (Lukas Bulwahn's message of "Mon, 15 Mar 2021 09:01:56 +0100")

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

> On Sun, Mar 14, 2021 at 9:18 PM Aditya Srivastava <yashsri421@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.

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

WARNING: multiple messages have this Message-ID (diff)
From: Kalle Valo <kvalo@codeaurora.org>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>,
	siva8118@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org,
	amitkarwar@gmail.com, David Miller <davem@davemloft.net>,
	Jakub Kicinski <kuba@kernel.org>,
	linux-wireless <linux-wireless@vger.kernel.org>,
	Netdev <netdev@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 00/10] rsi: fix comment syntax in file headers
Date: Mon, 15 Mar 2021 10:41:30 +0200	[thread overview]
Message-ID: <87a6r4u7ut.fsf@codeaurora.org> (raw)
In-Reply-To: <CAKXUXMzH-cUVeuCT6eM_0iHzgKpzvZUPO6pKNpD0yUp2td09Ug@mail.gmail.com> (Lukas Bulwahn's message of "Mon, 15 Mar 2021 09:01:56 +0100")

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

> On Sun, Mar 14, 2021 at 9:18 PM Aditya Srivastava <yashsri421@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.

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

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

  reply	other threads:[~2021-03-15  8:41 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-14 20:18 [PATCH 00/10] rsi: fix comment syntax in file headers Aditya Srivastava
2021-03-14 20:18 ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 01/10] rsi: rsi_boot_params: fix file header comment syntax Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 02/10] rsi: rsi_coex: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 03/10] rsi: rsi_ps: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 04/10] rsi: rsi_common: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 05/10] rsi: rsi_mgmt: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 06/10] rsi: rsi_main: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 07/10] rsi: rsi_hal: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 08/10] rsi: rsi_debugfs: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 09/10] rsi: rsi_sdio: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-14 20:18 ` [PATCH 10/10] rsi: rsi_usb: " Aditya Srivastava
2021-03-14 20:18   ` Aditya Srivastava
2021-03-15  8:01 ` [PATCH 00/10] rsi: fix comment syntax in file headers Lukas Bulwahn
2021-03-15  8:01   ` Lukas Bulwahn
2021-03-15  8:41   ` Kalle Valo [this message]
2021-03-15  8:41     ` Kalle Valo
2021-03-15 17:28     ` Aditya
2021-03-15 17:28       ` Aditya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a6r4u7ut.fsf@codeaurora.org \
    --to=kvalo@codeaurora.org \
    --cc=amitkarwar@gmail.com \
    --cc=davem@davemloft.net \
    --cc=kuba@kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=siva8118@gmail.com \
    --cc=yashsri421@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.