From: Andy Shevchenko <andriy.shevchenko@linux•intel.com>
To: Russell Currey <ruscur@russell•cc>,
Sam Bobroff <sbobroff@linux•ibm.com>,
"Oliver O'Halloran" <oohall@gmail•com>,
linuxppc-dev@lists•ozlabs.org,
Bjorn Helgaas <bhelgaas@google•com>,
linux-pci@vger•kernel.org
Cc: Andy Shevchenko <andriy.shevchenko@linux•intel.com>
Subject: [PATCH v1 2/2] PCI/AER: Update parameter descriptions to satisfy kernel-doc validator
Date: Tue, 27 Aug 2019 18:18:23 +0300 [thread overview]
Message-ID: <20190827151823.75312-2-andriy.shevchenko@linux.intel.com> (raw)
In-Reply-To: <20190827151823.75312-1-andriy.shevchenko@linux.intel.com>
Kernel-doc validator complains:
aer.c:207: warning: Function parameter or member 'str' not described in 'pcie_ecrc_get_policy'
aer.c:1209: warning: Function parameter or member 'irq' not described in 'aer_isr'
aer.c:1209: warning: Function parameter or member 'context' not described in 'aer_isr'
aer.c:1209: warning: Excess function parameter 'work' description in 'aer_isr'
Fix the above accordingly.
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux•intel.com>
---
drivers/pci/pcie/aer.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c
index f883f81d759a..6073eaab099d 100644
--- a/drivers/pci/pcie/aer.c
+++ b/drivers/pci/pcie/aer.c
@@ -202,6 +202,7 @@ void pcie_set_ecrc_checking(struct pci_dev *dev)
/**
* pcie_ecrc_get_policy - parse kernel command-line ecrc option
+ * @str: ECRC policy from kernel command line to use
*/
void pcie_ecrc_get_policy(char *str)
{
@@ -1201,7 +1202,8 @@ static void aer_isr_one_error(struct aer_rpc *rpc,
/**
* aer_isr - consume errors detected by root port
- * @work: definition of this work item
+ * @irq: IRQ assigned to Root Port
+ * @context: pointer to Root Port data structure
*
* Invoked, as DPC, when root port records new detected error
*/
--
2.23.0.rc1
next prev parent reply other threads:[~2019-08-27 15:26 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-27 15:18 [PATCH v1 1/2] PCI/AER: Use for_each_set_bit() Andy Shevchenko
2019-08-27 15:18 ` Andy Shevchenko [this message]
2019-08-27 17:06 ` [PATCH v1 2/2] PCI/AER: Update parameter descriptions to satisfy kernel-doc validator Kuppuswamy Sathyanarayanan
2019-08-28 10:07 ` Andy Shevchenko
2019-08-27 17:06 ` [PATCH v1 1/2] PCI/AER: Use for_each_set_bit() Kuppuswamy Sathyanarayanan
2019-09-27 10:44 ` Bjorn Helgaas
2019-09-27 12:39 ` Bjorn Helgaas
2019-09-30 12:13 ` Andy Shevchenko
2019-10-02 10:27 ` David Howells
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=20190827151823.75312-2-andriy.shevchenko@linux.intel.com \
--to=andriy.shevchenko@linux$(echo .)intel.com \
--cc=bhelgaas@google$(echo .)com \
--cc=linux-pci@vger$(echo .)kernel.org \
--cc=linuxppc-dev@lists$(echo .)ozlabs.org \
--cc=oohall@gmail$(echo .)com \
--cc=ruscur@russell$(echo .)cc \
--cc=sbobroff@linux$(echo .)ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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