From: Randy Dunlap <rdunlap@infradead.org>
To: Aditya Srivastava <yashsri421@gmail.com>, kvalo@codeaurora.org
Cc: lukas.bulwahn@gmail.com,
linux-kernel-mentees@lists.linuxfoundation.org,
amitkarwar@gmail.com, siva8118@gmail.com, davem@davemloft.net,
kuba@kernel.org, linux-wireless@vger.kernel.org,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] rsi: fix comment syntax in file headers
Date: Mon, 15 Mar 2021 15:32:49 -0700 [thread overview]
Message-ID: <dd3c5da5-ec8e-1354-3ab9-bf4c4f90a378@infradead.org> (raw)
In-Reply-To: <20210315173259.8757-1-yashsri421@gmail.com>
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 <yashsri421@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
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
next prev parent reply other threads:[~2021-03-15 22:34 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-15 17:32 [PATCH v2] rsi: fix comment syntax in file headers Aditya Srivastava
2021-03-15 22:32 ` Randy Dunlap [this message]
2021-04-18 6:28 ` Kalle Valo
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=dd3c5da5-ec8e-1354-3ab9-bf4c4f90a378@infradead.org \
--to=rdunlap@infradead.org \
--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 \
--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 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).