| Message ID | 20220823030056.123709-1-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | Rejected |
| Headers | show |
| Series | mips: pci: remove extraneous asterisk from top level comment of ar2315 PCI driver | expand |
On Tue, Aug 23, 2022 at 10:00:56AM +0700, Bagas Sanjaya wrote: > 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 kerneldoc issues are not stable worth, sorry. thanks, greg k-h
On 8/23/22 13:28, Greg KH wrote: > On Tue, Aug 23, 2022 at 10:00:56AM +0700, Bagas Sanjaya wrote: >> 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 > > kerneldoc issues are not stable worth, sorry. > Thanks for reminding me. Should I resend without Cc stable?
On Tue, Aug 23, 2022 at 6:01 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote: > > 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> Acked-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
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.
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(-) base-commit: 072e51356cd5a4a1c12c1020bc054c99b98333df