| Message ID | 20190827151823.75312-2-andriy.shevchenko@linux.intel.com (mailing list archive) |
|---|---|
| State | Mainlined, archived |
| Commit | 161eea1b25268a1f7fa8d220a3f0c350b4cc491c |
| Headers | show |
| Series | [v1,1/2] PCI/AER: Use for_each_set_bit() | expand |
On 8/27/19 8:18 AM, Andy Shevchenko wrote: > 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> Reviewed-by: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@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 > */
On Tue, Aug 27, 2019 at 10:06:54AM -0700, Kuppuswamy Sathyanarayanan wrote: > > On 8/27/19 8:18 AM, Andy Shevchenko wrote: > > 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> > Reviewed-by: Kuppuswamy Sathyanarayanan > <sathyanarayanan.kuppuswamy@linux.intel.com> Thanks! JFYI: Keep your tag on one line. Some bots require this IIRC (patchwork).
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 */
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(-)