[v1,2/2] x86/PCI: Describe @reg for type1_access_ok()
diff mbox series

Message ID 20200713194437.11325-2-andriy.shevchenko@linux.intel.com
State Not Applicable
Headers show
Series
  • Untitled series #317583
Related show

Commit Message

Andy Shevchenko July 13, 2020, 7:44 p.m. UTC
Describe missed parameter in documentation of type1_access_ok().
Otherwise we get the following warning:

  CHECK   arch/x86/pci/intel_mid_pci.c
  CC      arch/x86/pci/intel_mid_pci.o
  arch/x86/pci/intel_mid_pci.c:152: warning: Function parameter or member 'reg' not described in 'type1_access_ok'

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 arch/x86/pci/intel_mid_pci.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Bjorn Helgaas July 13, 2020, 7:59 p.m. UTC | #1
On Mon, Jul 13, 2020 at 10:44:37PM +0300, Andy Shevchenko wrote:
> Describe missed parameter in documentation of type1_access_ok().
> Otherwise we get the following warning:

Would you mind including the "make" invocation that runs this
checking?  I assume it's something like "make C=2
arch/x86/pci/intel_mid_pci.o"?

I'm not in the habit of running these checks, but maybe seeing how
easy it is will help me and others get in the habit.

>   CHECK   arch/x86/pci/intel_mid_pci.c
>   CC      arch/x86/pci/intel_mid_pci.o
>   arch/x86/pci/intel_mid_pci.c:152: warning: Function parameter or member 'reg' not described in 'type1_access_ok'
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>  arch/x86/pci/intel_mid_pci.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/arch/x86/pci/intel_mid_pci.c b/arch/x86/pci/intel_mid_pci.c
> index d8af4787e616..f855e12d7bed 100644
> --- a/arch/x86/pci/intel_mid_pci.c
> +++ b/arch/x86/pci/intel_mid_pci.c
> @@ -141,6 +141,7 @@ static int pci_device_update_fixed(struct pci_bus *bus, unsigned int devfn,
>   * type1_access_ok - check whether to use type 1
>   * @bus: bus number
>   * @devfn: device & function in question
> + * @reg: configuration register offset
>   *
>   * If the bus is on a Lincroft chip and it exists, or is not on a Lincroft at
>   * all, the we can go ahead with any reads & writes.  If it's on a Lincroft,
> -- 
> 2.27.0
>
Andy Shevchenko July 13, 2020, 8:03 p.m. UTC | #2
On Mon, Jul 13, 2020 at 02:59:07PM -0500, Bjorn Helgaas wrote:
> On Mon, Jul 13, 2020 at 10:44:37PM +0300, Andy Shevchenko wrote:
> > Describe missed parameter in documentation of type1_access_ok().
> > Otherwise we get the following warning:
> 
> Would you mind including the "make" invocation that runs this
> checking?  I assume it's something like "make C=2
> arch/x86/pci/intel_mid_pci.o"?

No, it is not sparse, it's a kernel doc validation.
I guess `make W=1` does it, but I can repeat my command line publicly again :-)
	make W=1 C=1 CF=-D__CHECK_ENDIAN__ -j64

> I'm not in the habit of running these checks, but maybe seeing how
> easy it is will help me and others get in the habit.
> 
> >   CHECK   arch/x86/pci/intel_mid_pci.c
> >   CC      arch/x86/pci/intel_mid_pci.o
> >   arch/x86/pci/intel_mid_pci.c:152: warning: Function parameter or member 'reg' not described in 'type1_access_ok'
> > 
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> > ---
> >  arch/x86/pci/intel_mid_pci.c | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/arch/x86/pci/intel_mid_pci.c b/arch/x86/pci/intel_mid_pci.c
> > index d8af4787e616..f855e12d7bed 100644
> > --- a/arch/x86/pci/intel_mid_pci.c
> > +++ b/arch/x86/pci/intel_mid_pci.c
> > @@ -141,6 +141,7 @@ static int pci_device_update_fixed(struct pci_bus *bus, unsigned int devfn,
> >   * type1_access_ok - check whether to use type 1
> >   * @bus: bus number
> >   * @devfn: device & function in question
> > + * @reg: configuration register offset
> >   *
> >   * If the bus is on a Lincroft chip and it exists, or is not on a Lincroft at
> >   * all, the we can go ahead with any reads & writes.  If it's on a Lincroft,
> > -- 
> > 2.27.0
> >
Bjorn Helgaas July 13, 2020, 9:02 p.m. UTC | #3
On Mon, Jul 13, 2020 at 11:03:38PM +0300, Andy Shevchenko wrote:
> On Mon, Jul 13, 2020 at 02:59:07PM -0500, Bjorn Helgaas wrote:
> > On Mon, Jul 13, 2020 at 10:44:37PM +0300, Andy Shevchenko wrote:
> > > Describe missed parameter in documentation of type1_access_ok().
> > > Otherwise we get the following warning:
> > 
> > Would you mind including the "make" invocation that runs this
> > checking?  I assume it's something like "make C=2
> > arch/x86/pci/intel_mid_pci.o"?
> 
> No, it is not sparse, it's a kernel doc validation.
> I guess `make W=1` does it, but I can repeat my command line publicly again :-)
> 	make W=1 C=1 CF=-D__CHECK_ENDIAN__ -j64

Thanks.  "make W=1 arch/x86/pci/" is enough.  I would just put this in
the commit log, e.g.,

  Otherwise "make W=1 arch/x86/pci/" produces the following warning:

    CHECK   arch/x86/pci/intel_mid_pci.c
    CC      arch/x86/pci/intel_mid_pci.o
    arch/x86/pci/intel_mid_pci.c:152: warning: Function parameter or member 'reg' not described in 'type1_access_ok'
Andy Shevchenko July 14, 2020, 9:09 a.m. UTC | #4
On Mon, Jul 13, 2020 at 04:02:40PM -0500, Bjorn Helgaas wrote:
> On Mon, Jul 13, 2020 at 11:03:38PM +0300, Andy Shevchenko wrote:
> > On Mon, Jul 13, 2020 at 02:59:07PM -0500, Bjorn Helgaas wrote:
> > > On Mon, Jul 13, 2020 at 10:44:37PM +0300, Andy Shevchenko wrote:
> > > > Describe missed parameter in documentation of type1_access_ok().
> > > > Otherwise we get the following warning:
> > > 
> > > Would you mind including the "make" invocation that runs this
> > > checking?  I assume it's something like "make C=2
> > > arch/x86/pci/intel_mid_pci.o"?
> > 
> > No, it is not sparse, it's a kernel doc validation.
> > I guess `make W=1` does it, but I can repeat my command line publicly again :-)
> > 	make W=1 C=1 CF=-D__CHECK_ENDIAN__ -j64
> 
> Thanks.  "make W=1 arch/x86/pci/" is enough.  I would just put this in
> the commit log, e.g.,
> 
>   Otherwise "make W=1 arch/x86/pci/" produces the following warning:
> 
>     CHECK   arch/x86/pci/intel_mid_pci.c
>     CC      arch/x86/pci/intel_mid_pci.o
>     arch/x86/pci/intel_mid_pci.c:152: warning: Function parameter or member 'reg' not described in 'type1_access_ok'

Will do.

Patch
diff mbox series

diff --git a/arch/x86/pci/intel_mid_pci.c b/arch/x86/pci/intel_mid_pci.c
index d8af4787e616..f855e12d7bed 100644
--- a/arch/x86/pci/intel_mid_pci.c
+++ b/arch/x86/pci/intel_mid_pci.c
@@ -141,6 +141,7 @@  static int pci_device_update_fixed(struct pci_bus *bus, unsigned int devfn,
  * type1_access_ok - check whether to use type 1
  * @bus: bus number
  * @devfn: device & function in question
+ * @reg: configuration register offset
  *
  * If the bus is on a Lincroft chip and it exists, or is not on a Lincroft at
  * all, the we can go ahead with any reads & writes.  If it's on a Lincroft,