[08/10] of: of_net: Demote non-conforming kernel-doc header

Message ID 20210312110758.2220959-9-lee.jones@linaro.org
State New
Headers show
Series
  • Rid W=1 warnings from OF
Related show

Commit Message

Lee Jones March 12, 2021, 11:07 a.m.
Fixes the following W=1 kernel build warning(s):

 drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'
 drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead

Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Heiner Kallweit <hkallweit1@gmail.com>
Cc: Russell King <linux@armlinux.org.uk>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: netdev@vger.kernel.org
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/of/of_net.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.27.0

Comments

Andrew Lunn March 12, 2021, 2:05 p.m. | #1
On Fri, Mar 12, 2021 at 11:07:56AM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'

>  drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead

> 

> Cc: Andrew Lunn <andrew@lunn.ch>

> Cc: Heiner Kallweit <hkallweit1@gmail.com>

> Cc: Russell King <linux@armlinux.org.uk>

> Cc: Rob Herring <robh+dt@kernel.org>

> Cc: Frank Rowand <frowand.list@gmail.com>

> Cc: netdev@vger.kernel.org

> Cc: devicetree@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/of/of_net.c | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c

> index 6e411821583e4..9b41a343e88ab 100644

> --- a/drivers/of/of_net.c

> +++ b/drivers/of/of_net.c

> @@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)

>  	return mac;

>  }

>  

> -/**

> +/*

>   * Search the device tree for the best MAC address to use.  'mac-address' is

>   * checked first, because that is supposed to contain to "most recent" MAC

>   * address. If that isn't set, then 'local-mac-address' is checked next,


Hi Lee

of_get_mac_address() is a pretty important API function. So it would
be better to add the missing header to make this valid kdoc.

/**
 * of_get_mac_address - Get MAC address from device tree
 * @np: Pointer to the device_node of the interface
 *

 Andrew
Lee Jones March 12, 2021, 3:18 p.m. | #2
On Fri, 12 Mar 2021, Andrew Lunn wrote:

> On Fri, Mar 12, 2021 at 11:07:56AM +0000, Lee Jones wrote:

> > Fixes the following W=1 kernel build warning(s):

> > 

> >  drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'

> >  drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead

> > 

> > Cc: Andrew Lunn <andrew@lunn.ch>

> > Cc: Heiner Kallweit <hkallweit1@gmail.com>

> > Cc: Russell King <linux@armlinux.org.uk>

> > Cc: Rob Herring <robh+dt@kernel.org>

> > Cc: Frank Rowand <frowand.list@gmail.com>

> > Cc: netdev@vger.kernel.org

> > Cc: devicetree@vger.kernel.org

> > Signed-off-by: Lee Jones <lee.jones@linaro.org>

> > ---

> >  drivers/of/of_net.c | 2 +-

> >  1 file changed, 1 insertion(+), 1 deletion(-)

> > 

> > diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c

> > index 6e411821583e4..9b41a343e88ab 100644

> > --- a/drivers/of/of_net.c

> > +++ b/drivers/of/of_net.c

> > @@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)

> >  	return mac;

> >  }

> >  

> > -/**

> > +/*

> >   * Search the device tree for the best MAC address to use.  'mac-address' is

> >   * checked first, because that is supposed to contain to "most recent" MAC

> >   * address. If that isn't set, then 'local-mac-address' is checked next,

> 

> Hi Lee

> 

> of_get_mac_address() is a pretty important API function. So it would

> be better to add the missing header to make this valid kdoc.


Pretty important, yes.  Referenced/documented, no. :)

  `git grep kernel-doc:: | grep drivers/of`

> /**

>  * of_get_mac_address - Get MAC address from device tree

>  * @np: Pointer to the device_node of the interface

>  *

> 

>  Andrew


-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

Patch

diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
index 6e411821583e4..9b41a343e88ab 100644
--- a/drivers/of/of_net.c
+++ b/drivers/of/of_net.c
@@ -78,7 +78,7 @@  static const void *of_get_mac_addr_nvmem(struct device_node *np)
 	return mac;
 }
 
-/**
+/*
  * Search the device tree for the best MAC address to use.  'mac-address' is
  * checked first, because that is supposed to contain to "most recent" MAC
  * address. If that isn't set, then 'local-mac-address' is checked next,