From: Randy Dunlap <rdunlap@infradead.org> To: Aditya Srivastava <yashsri421@gmail.com>, bhelgaas@google.com Cc: lukas.bulwahn@gmail.com, linux-kernel-mentees@lists.linuxfoundation.org, linux-doc@vger.kernel.org, linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] PCI: endpoint: fix incorrect kernel-doc comment syntax Date: Sun, 11 Apr 2021 09:04:35 -0700 [thread overview] Message-ID: <42f7fe6e-6f53-5572-f3e0-0dfd0e3d921b@infradead.org> (raw) In-Reply-To: <20210411101508.11065-1-yashsri421@gmail.com> On 4/11/21 3:15 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in include/linux/pci*, which follow this syntax, > but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in include/linux/pci-ep-cfs.h at > header causes this warnings by kernel-doc: > "warning: expecting prototype for PCI Endpoint ConfigFS header file(). Prototype was for __LINUX_PCI_EP_CFS_H() instead" > > 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> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > include/linux/pci-ep-cfs.h | 2 +- > include/linux/pci-epc.h | 2 +- > include/linux/pci-epf.h | 2 +- > 3 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/include/linux/pci-ep-cfs.h b/include/linux/pci-ep-cfs.h > index 662881335c7e..3e2140d7e31d 100644 > --- a/include/linux/pci-ep-cfs.h > +++ b/include/linux/pci-ep-cfs.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0+ */ > -/** > +/* > * PCI Endpoint ConfigFS header file > * > * Copyright (C) 2017 Texas Instruments > diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h > index b82c9b100e97..80197a6df371 100644 > --- a/include/linux/pci-epc.h > +++ b/include/linux/pci-epc.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * PCI Endpoint *Controller* (EPC) header file > * > * Copyright (C) 2017 Texas Instruments > diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h > index 6833e2160ef1..c43912b1d2d0 100644 > --- a/include/linux/pci-epf.h > +++ b/include/linux/pci-epf.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * PCI Endpoint *Function* (EPF) header file > * > * Copyright (C) 2017 Texas Instruments > -- ~Randy
WARNING: multiple messages have this Message-ID (diff)
From: Randy Dunlap <rdunlap@infradead.org> To: Aditya Srivastava <yashsri421@gmail.com>, bhelgaas@google.com Cc: linux-pci@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org Subject: Re: [PATCH] PCI: endpoint: fix incorrect kernel-doc comment syntax Date: Sun, 11 Apr 2021 09:04:35 -0700 [thread overview] Message-ID: <42f7fe6e-6f53-5572-f3e0-0dfd0e3d921b@infradead.org> (raw) In-Reply-To: <20210411101508.11065-1-yashsri421@gmail.com> On 4/11/21 3:15 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in include/linux/pci*, which follow this syntax, > but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in include/linux/pci-ep-cfs.h at > header causes this warnings by kernel-doc: > "warning: expecting prototype for PCI Endpoint ConfigFS header file(). Prototype was for __LINUX_PCI_EP_CFS_H() instead" > > 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> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > include/linux/pci-ep-cfs.h | 2 +- > include/linux/pci-epc.h | 2 +- > include/linux/pci-epf.h | 2 +- > 3 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/include/linux/pci-ep-cfs.h b/include/linux/pci-ep-cfs.h > index 662881335c7e..3e2140d7e31d 100644 > --- a/include/linux/pci-ep-cfs.h > +++ b/include/linux/pci-ep-cfs.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0+ */ > -/** > +/* > * PCI Endpoint ConfigFS header file > * > * Copyright (C) 2017 Texas Instruments > diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h > index b82c9b100e97..80197a6df371 100644 > --- a/include/linux/pci-epc.h > +++ b/include/linux/pci-epc.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * PCI Endpoint *Controller* (EPC) header file > * > * Copyright (C) 2017 Texas Instruments > diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h > index 6833e2160ef1..c43912b1d2d0 100644 > --- a/include/linux/pci-epf.h > +++ b/include/linux/pci-epf.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * PCI Endpoint *Function* (EPF) header file > * > * Copyright (C) 2017 Texas Instruments > -- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2021-04-11 16:04 UTC|newest] Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-04-11 10:15 [PATCH] PCI: endpoint: fix incorrect kernel-doc comment syntax Aditya Srivastava 2021-04-11 10:15 ` Aditya Srivastava 2021-04-11 16:04 ` Randy Dunlap [this message] 2021-04-11 16:04 ` Randy Dunlap
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=42f7fe6e-6f53-5572-f3e0-0dfd0e3d921b@infradead.org \ --to=rdunlap@infradead.org \ --cc=bhelgaas@google.com \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel-mentees@lists.linuxfoundation.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-pci@vger.kernel.org \ --cc=lukas.bulwahn@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: linkBe 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.