linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Aditya Srivastava <yashsri421@gmail.com>
To: siva8118@gmail.com
Cc: yashsri421@gmail.com, lukas.bulwahn@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org,
	amitkarwar@gmail.com, kvalo@codeaurora.org, davem@davemloft.net,
	kuba@kernel.org, linux-wireless@vger.kernel.org,
	netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 01/10] rsi: rsi_boot_params: fix file header comment syntax
Date: Mon, 15 Mar 2021 01:48:09 +0530	[thread overview]
Message-ID: <20210314201818.27380-2-yashsri421@gmail.com> (raw)
In-Reply-To: <20210314201818.27380-1-yashsri421@gmail.com>

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.

The header comment used in drivers/net/wireless/rsi/rsi_boot_params.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).

This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
 * Copyright (c) 2014 Redpine Signals Inc."

Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing these

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
 drivers/net/wireless/rsi/rsi_boot_params.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/wireless/rsi/rsi_boot_params.h b/drivers/net/wireless/rsi/rsi_boot_params.h
index c1cf19d1e376..30e03aa6a529 100644
--- a/drivers/net/wireless/rsi/rsi_boot_params.h
+++ b/drivers/net/wireless/rsi/rsi_boot_params.h
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2014 Redpine Signals Inc.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
-- 
2.17.1


  reply	other threads:[~2021-03-14 20:19 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 ` Aditya Srivastava [this message]
2021-03-14 20:18 ` [PATCH 02/10] rsi: rsi_coex: fix file header comment syntax 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

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=20210314201818.27380-2-yashsri421@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).