* [PATCH 00/10] Rid W=1 warnings from OF
@ 2021-03-12 11:07 Lee Jones
2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
0 siblings, 1 reply; 4+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
To: lee.jones
Cc: linux-kernel, Andrew Lunn, Anton Vorontsov, benh, Colin Cross,
David S. Miller, devicetree, Frank Rowand, Heiner Kallweit,
Josh Cartwright, Kees Cook, Marek Szyprowski, netdev,
Pantelis Antoniou, Rob Herring, Russell King, Tony Luck
This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.
Lee Jones (10):
of: device: Fix function name in header and demote kernel-doc abuse
of: dynamic: Fix incorrect parameter name and demote kernel-doc abuse
of: platform: Demote kernel-doc abuse
of: base: Fix some formatting issues and demote non-conformant
kernel-doc headers
of: property: Provide missing member description and remove excess
param
of: address: Demote non-conformant kernel-doc header
of: fdt: Demote kernel-doc abuses
of: of_net: Demote non-conforming kernel-doc header
of: overlay: Fix function name disparity
of: of_reserved_mem: Demote kernel-doc abuses
drivers/of/address.c | 2 +-
drivers/of/base.c | 16 ++++++++--------
drivers/of/device.c | 6 +++---
drivers/of/dynamic.c | 6 +++---
drivers/of/fdt.c | 19 ++++++++++---------
drivers/of/of_net.c | 2 +-
drivers/of/of_reserved_mem.c | 6 +++---
drivers/of/overlay.c | 2 +-
drivers/of/platform.c | 2 +-
drivers/of/property.c | 2 +-
10 files changed, 32 insertions(+), 31 deletions(-)
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Anton Vorontsov <anton@enomsg.org>
Cc: benh@kernel.crashing.org
Cc: Colin Cross <ccross@android.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: devicetree@vger.kernel.org
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Heiner Kallweit <hkallweit1@gmail.com>
Cc: Josh Cartwright <joshc@codeaurora.org>
Cc: Kees Cook <keescook@chromium.org>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
Cc: netdev@vger.kernel.org
Cc: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Russell King <linux@armlinux.org.uk>
Cc: Tony Luck <tony.luck@intel.com>
--
2.27.0
^ permalink raw reply [flat|nested] 4+ messages in thread* [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
2021-03-12 14:05 ` Andrew Lunn
0 siblings, 1 reply; 4+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
To: lee.jones
Cc: linux-kernel, Andrew Lunn, Heiner Kallweit, Russell King,
Rob Herring, Frank Rowand, netdev, devicetree
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,
--
2.27.0
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
@ 2021-03-12 14:05 ` Andrew Lunn
2021-03-12 15:18 ` Lee Jones
0 siblings, 1 reply; 4+ messages in thread
From: Andrew Lunn @ 2021-03-12 14:05 UTC (permalink / raw)
To: Lee Jones
Cc: linux-kernel, Heiner Kallweit, Russell King, Rob Herring,
Frank Rowand, netdev, devicetree
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
2021-03-12 14:05 ` Andrew Lunn
@ 2021-03-12 15:18 ` Lee Jones
0 siblings, 0 replies; 4+ messages in thread
From: Lee Jones @ 2021-03-12 15:18 UTC (permalink / raw)
To: Andrew Lunn
Cc: linux-kernel, Heiner Kallweit, Russell King, Rob Herring,
Frank Rowand, netdev, devicetree
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-03-12 15:19 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
2021-03-12 14:05 ` Andrew Lunn
2021-03-12 15:18 ` Lee Jones
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).