linux-kernel-mentees.lists.linuxfoundation.org archive mirror
 help / color / mirror / Atom feed
From: Aditya <yashsri421@gmail.com>
To: Kalle Valo <kvalo@codeaurora.org>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: 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 22:58:32 +0530	[thread overview]
Message-ID: <643c93f6-1c01-a18d-6ef6-d4d0fb5304fa@gmail.com> (raw)
In-Reply-To: <87a6r4u7ut.fsf@codeaurora.org>

On 15/3/21 2:11 pm, Kalle Valo wrote:
> 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.
> 

Thanks for the feedback Lukas and Kalle. I will be sending the
modified v2.

Thanks
Aditya
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

      reply	other threads:[~2021-03-15 17:28 UTC|newest]

Thread overview: 14+ 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 ` [PATCH 01/10] rsi: rsi_boot_params: fix file header comment syntax Aditya Srivastava
2021-03-14 20:18 ` [PATCH 02/10] rsi: rsi_coex: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 03/10] rsi: rsi_ps: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 04/10] rsi: rsi_common: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 05/10] rsi: rsi_mgmt: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 06/10] rsi: rsi_main: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 07/10] rsi: rsi_hal: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 08/10] rsi: rsi_debugfs: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 09/10] rsi: rsi_sdio: " Aditya Srivastava
2021-03-14 20:18 ` [PATCH 10/10] rsi: rsi_usb: " Aditya Srivastava
2021-03-15  8:01 ` [PATCH 00/10] rsi: fix comment syntax in file headers Lukas Bulwahn
2021-03-15  8:41   ` Kalle Valo
2021-03-15 17:28     ` Aditya [this message]

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=643c93f6-1c01-a18d-6ef6-d4d0fb5304fa@gmail.com \
    --to=yashsri421@gmail.com \
    --cc=amitkarwar@gmail.com \
    --cc=davem@davemloft.net \
    --cc=kuba@kernel.org \
    --cc=kvalo@codeaurora.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 \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).