From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org, linux-mips@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>,
Rikard Falkeborn <rikard.falkeborn@gmail.com>,
Sergey Ryazanov <ryazanov.s.a@gmail.com>,
Ralf Baechle <ralf@linux-mips.org>,
Jonathan Corbet <corbet@lwn.net>,
Aditya Srivastava <yashsri421@gmail.com>,
Bagas Sanjaya <bagasdotme@gmail.com>,
kernel test robot <lkp@intel.com>,
stable@vger.kernel.org
Subject: [PATCH] mips: pci: remove extraneous asterisk from top level comment of ar2315 PCI driver
Date: Tue, 23 Aug 2022 10:00:56 +0700 [thread overview]
Message-ID: <20220823030056.123709-1-bagasdotme@gmail.com> (raw)
In-Reply-To: <202208221854.8ASrzjKa-lkp@intel.com>
kernel test robot reported kernel-doc warning:
arch/mips/pci/pci-ar2315.c:6: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
The warning above is caused by an extraneous asterisk on the top level
(description) comment of pci-ar2315.c, for which the comment is confused as
kernel-doc comment instead.
Remove the asterisk.
Link: https://lore.kernel.org/linux-doc/202208221854.8ASrzjKa-lkp@intel.com/
Fixes: 3ed7a2a702dc0f ("MIPS: ath25: add AR2315 PCI host controller driver")
Fixes: 3e58e839150db0 ("scripts: kernel-doc: add warning for comment not following kernel-doc syntax")
Reported-by: kernel test robot <lkp@intel.com>
Cc: stable@vger.kernel.org # v5.15, v5.19
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
The second Fixes: commit exposes the kernel-doc warning, which the
culprit is actually the first Fixes: commit, so it make sense to apply
this patch to supported stable branches after the second commit one.
arch/mips/pci/pci-ar2315.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/arch/mips/pci/pci-ar2315.c b/arch/mips/pci/pci-ar2315.c
index 30e0922f4ceaec..e17d862cfa4c6a 100644
--- a/arch/mips/pci/pci-ar2315.c
+++ b/arch/mips/pci/pci-ar2315.c
@@ -2,7 +2,7 @@
/*
*/
-/**
+/*
* Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
* and interrupt. PCI interface supports MMIO access method, but does not
* seem to support I/O ports.
base-commit: 072e51356cd5a4a1c12c1020bc054c99b98333df
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-08-23 3:02 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-22 10:31 arch/mips/pci/pci-ar2315.c:6: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst kernel test robot
2022-08-23 3:00 ` Bagas Sanjaya [this message]
2022-08-23 6:28 ` [PATCH] mips: pci: remove extraneous asterisk from top level comment of ar2315 PCI driver Greg KH
2022-08-23 7:55 ` Bagas Sanjaya
2022-08-23 8:06 ` Sergey Ryazanov
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=20220823030056.123709-1-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@vger.kernel.org \
--cc=lkp@intel.com \
--cc=ralf@linux-mips.org \
--cc=rikard.falkeborn@gmail.com \
--cc=ryazanov.s.a@gmail.com \
--cc=stable@vger.kernel.org \
--cc=tsbogend@alpha.franken.de \
--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.