* [PATCH v2 00/10] Rid W=1 warnings from OF
@ 2021-03-18 10:40 Lee Jones
2021-03-18 10:40 ` [PATCH 08/10] of: of_net: Provide function name and param description Lee Jones
2021-03-22 22:22 ` [PATCH v2 00/10] Rid W=1 warnings from OF Rob Herring
0 siblings, 2 replies; 7+ messages in thread
From: Lee Jones @ 2021-03-18 10:40 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.
v2:
- Provided some descriptions to exported functions
Lee Jones (10):
of: device: Fix function name in header and provide missing
descriptions
of: dynamic: Fix incorrect parameter name and provide missing
descriptions
of: platform: Demote kernel-doc abuse
of: base: Fix some formatting issues and provide missing descriptions
of: property: Provide missing member description and remove excess
param
of: address: Provide descriptions for 'of_address_to_resource's params
of: fdt: Demote kernel-doc abuses and fix function naming
of: of_net: Provide function name and param description
of: overlay: Fix function name disparity
of: of_reserved_mem: Demote kernel-doc abuses
drivers/of/address.c | 3 +++
drivers/of/base.c | 16 +++++++++++-----
drivers/of/device.c | 7 ++++++-
drivers/of/dynamic.c | 4 +++-
drivers/of/fdt.c | 23 ++++++++++++-----------
drivers/of/of_net.c | 3 +++
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, 44 insertions(+), 24 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] 7+ messages in thread
* [PATCH 08/10] of: of_net: Provide function name and param description
2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
@ 2021-03-18 10:40 ` Lee Jones
2021-03-18 13:10 ` Andrew Lunn
2021-03-22 22:22 ` [PATCH v2 00/10] Rid W=1 warnings from OF Rob Herring
1 sibling, 1 reply; 7+ messages in thread
From: Lee Jones @ 2021-03-18 10:40 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 | 3 +++
1 file changed, 3 insertions(+)
diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
index 6e411821583e4..bc0a27de69d4c 100644
--- a/drivers/of/of_net.c
+++ b/drivers/of/of_net.c
@@ -79,6 +79,9 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)
}
/**
+ * of_get_mac_address()
+ * @np: Caller's Device Node
+ *
* 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] 7+ messages in thread
* Re: [PATCH 08/10] of: of_net: Provide function name and param description
2021-03-18 10:40 ` [PATCH 08/10] of: of_net: Provide function name and param description Lee Jones
@ 2021-03-18 13:10 ` Andrew Lunn
0 siblings, 0 replies; 7+ messages in thread
From: Andrew Lunn @ 2021-03-18 13:10 UTC (permalink / raw)
To: Lee Jones
Cc: linux-kernel, Heiner Kallweit, Russell King, Rob Herring,
Frank Rowand, netdev, devicetree
On Thu, Mar 18, 2021 at 10:40:34AM +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>
Thanks for fixing it up.
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Andrew
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 00/10] Rid W=1 warnings from OF
2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-18 10:40 ` [PATCH 08/10] of: of_net: Provide function name and param description Lee Jones
@ 2021-03-22 22:22 ` Rob Herring
2021-03-23 8:36 ` Lee Jones
1 sibling, 1 reply; 7+ messages in thread
From: Rob Herring @ 2021-03-22 22:22 UTC (permalink / raw)
To: Lee Jones
Cc: linux-kernel@vger.kernel.org, Andrew Lunn, Anton Vorontsov,
Benjamin Herrenschmidt, Colin Cross, David S. Miller, devicetree,
Frank Rowand, Heiner Kallweit, Josh Cartwright, Kees Cook,
Marek Szyprowski, netdev, Pantelis Antoniou, Russell King,
Tony Luck
On Thu, Mar 18, 2021 at 4:40 AM Lee Jones <lee.jones@linaro.org> wrote:
>
> 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.
>
> v2:
> - Provided some descriptions to exported functions
>
> Lee Jones (10):
> of: device: Fix function name in header and provide missing
> descriptions
> of: dynamic: Fix incorrect parameter name and provide missing
> descriptions
> of: platform: Demote kernel-doc abuse
> of: base: Fix some formatting issues and provide missing descriptions
> of: property: Provide missing member description and remove excess
> param
> of: address: Provide descriptions for 'of_address_to_resource's params
> of: fdt: Demote kernel-doc abuses and fix function naming
> of: of_net: Provide function name and param description
> of: overlay: Fix function name disparity
> of: of_reserved_mem: Demote kernel-doc abuses
>
> drivers/of/address.c | 3 +++
> drivers/of/base.c | 16 +++++++++++-----
> drivers/of/device.c | 7 ++++++-
> drivers/of/dynamic.c | 4 +++-
> drivers/of/fdt.c | 23 ++++++++++++-----------
> drivers/of/of_net.c | 3 +++
> 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, 44 insertions(+), 24 deletions(-)
I still see some warnings (note this is with DT files added to doc
build). Can you send follow-up patches:
../include/linux/of.h:1193: warning: Function parameter or member
'output' not described in 'of_property_read_string_index'
../include/linux/of.h:1193: warning: Excess function parameter
'out_string' description in 'of_property_read_string_index'
../include/linux/of.h:1461: warning: cannot understand function
prototype: 'enum of_overlay_notify_action '
../drivers/of/base.c:1781: warning: Excess function parameter 'prob'
description in '__of_add_property'
../drivers/of/base.c:1804: warning: Excess function parameter 'prob'
description in 'of_add_property'
../drivers/of/base.c:1855: warning: Function parameter or member
'prop' not described in 'of_remove_property'
../drivers/of/base.c:1855: warning: Excess function parameter 'prob'
description in 'of_remove_property'
BTW, there some more which I guess W=1 doesn't find:
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:906: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1465: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1469: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1473: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1517: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1521: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1526: WARNING: Unexpected indentation.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1528: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1529: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1533: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
../drivers/of/base.c:1705: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:49:
../drivers/of/overlay.c:1183: WARNING: Inline emphasis start-string
without end-string.
Rob
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 00/10] Rid W=1 warnings from OF
2021-03-22 22:22 ` [PATCH v2 00/10] Rid W=1 warnings from OF Rob Herring
@ 2021-03-23 8:36 ` Lee Jones
2021-03-24 14:09 ` Rob Herring
0 siblings, 1 reply; 7+ messages in thread
From: Lee Jones @ 2021-03-23 8:36 UTC (permalink / raw)
To: Rob Herring
Cc: linux-kernel@vger.kernel.org, Andrew Lunn, Anton Vorontsov,
Benjamin Herrenschmidt, Colin Cross, David S. Miller, devicetree,
Frank Rowand, Heiner Kallweit, Josh Cartwright, Kees Cook,
Marek Szyprowski, netdev, Pantelis Antoniou, Russell King,
Tony Luck
On Mon, 22 Mar 2021, Rob Herring wrote:
> On Thu, Mar 18, 2021 at 4:40 AM Lee Jones <lee.jones@linaro.org> wrote:
> >
> > 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.
> >
> > v2:
> > - Provided some descriptions to exported functions
> >
> > Lee Jones (10):
> > of: device: Fix function name in header and provide missing
> > descriptions
> > of: dynamic: Fix incorrect parameter name and provide missing
> > descriptions
> > of: platform: Demote kernel-doc abuse
> > of: base: Fix some formatting issues and provide missing descriptions
> > of: property: Provide missing member description and remove excess
> > param
> > of: address: Provide descriptions for 'of_address_to_resource's params
> > of: fdt: Demote kernel-doc abuses and fix function naming
> > of: of_net: Provide function name and param description
> > of: overlay: Fix function name disparity
> > of: of_reserved_mem: Demote kernel-doc abuses
> >
> > drivers/of/address.c | 3 +++
> > drivers/of/base.c | 16 +++++++++++-----
> > drivers/of/device.c | 7 ++++++-
> > drivers/of/dynamic.c | 4 +++-
> > drivers/of/fdt.c | 23 ++++++++++++-----------
> > drivers/of/of_net.c | 3 +++
> > 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, 44 insertions(+), 24 deletions(-)
>
> I still see some warnings (note this is with DT files added to doc
> build). Can you send follow-up patches:
>
> ../include/linux/of.h:1193: warning: Function parameter or member
> 'output' not described in 'of_property_read_string_index'
> ../include/linux/of.h:1193: warning: Excess function parameter
> 'out_string' description in 'of_property_read_string_index'
> ../include/linux/of.h:1461: warning: cannot understand function
> prototype: 'enum of_overlay_notify_action '
> ../drivers/of/base.c:1781: warning: Excess function parameter 'prob'
> description in '__of_add_property'
> ../drivers/of/base.c:1804: warning: Excess function parameter 'prob'
> description in 'of_add_property'
> ../drivers/of/base.c:1855: warning: Function parameter or member
> 'prop' not described in 'of_remove_property'
> ../drivers/of/base.c:1855: warning: Excess function parameter 'prob'
> description in 'of_remove_property'
You don't want much do you! ;)
Sure, I plan to clean up all of the kernel with subsequent patches.
> BTW, there some more which I guess W=1 doesn't find:
>
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:906: WARNING: Block quote ends without a blank
> line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1465: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1469: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1473: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1517: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1521: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1526: WARNING: Unexpected indentation.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1528: WARNING: Block quote ends without a blank
> line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1529: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1533: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> ../drivers/of/base.c:1705: WARNING: Definition list ends without a
> blank line; unexpected unindent.
> /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:49:
> ../drivers/of/overlay.c:1183: WARNING: Inline emphasis start-string
> without end-string.
What command did you use to find these?
--
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] 7+ messages in thread
* Re: [PATCH v2 00/10] Rid W=1 warnings from OF
2021-03-23 8:36 ` Lee Jones
@ 2021-03-24 14:09 ` Rob Herring
2021-03-24 15:12 ` Lee Jones
0 siblings, 1 reply; 7+ messages in thread
From: Rob Herring @ 2021-03-24 14:09 UTC (permalink / raw)
To: Lee Jones
Cc: linux-kernel@vger.kernel.org, Andrew Lunn, Anton Vorontsov,
Benjamin Herrenschmidt, Colin Cross, David S. Miller, devicetree,
Frank Rowand, Heiner Kallweit, Josh Cartwright, Kees Cook,
Marek Szyprowski, netdev, Pantelis Antoniou, Russell King,
Tony Luck
On Tue, Mar 23, 2021 at 2:36 AM Lee Jones <lee.jones@linaro.org> wrote:
>
> On Mon, 22 Mar 2021, Rob Herring wrote:
>
> > On Thu, Mar 18, 2021 at 4:40 AM Lee Jones <lee.jones@linaro.org> wrote:
> > >
> > > 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.
> > >
> > > v2:
> > > - Provided some descriptions to exported functions
> > >
> > > Lee Jones (10):
> > > of: device: Fix function name in header and provide missing
> > > descriptions
> > > of: dynamic: Fix incorrect parameter name and provide missing
> > > descriptions
> > > of: platform: Demote kernel-doc abuse
> > > of: base: Fix some formatting issues and provide missing descriptions
> > > of: property: Provide missing member description and remove excess
> > > param
> > > of: address: Provide descriptions for 'of_address_to_resource's params
> > > of: fdt: Demote kernel-doc abuses and fix function naming
> > > of: of_net: Provide function name and param description
> > > of: overlay: Fix function name disparity
> > > of: of_reserved_mem: Demote kernel-doc abuses
> > >
> > > drivers/of/address.c | 3 +++
> > > drivers/of/base.c | 16 +++++++++++-----
> > > drivers/of/device.c | 7 ++++++-
> > > drivers/of/dynamic.c | 4 +++-
> > > drivers/of/fdt.c | 23 ++++++++++++-----------
> > > drivers/of/of_net.c | 3 +++
> > > 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, 44 insertions(+), 24 deletions(-)
> >
> > I still see some warnings (note this is with DT files added to doc
> > build). Can you send follow-up patches:
> >
> > ../include/linux/of.h:1193: warning: Function parameter or member
> > 'output' not described in 'of_property_read_string_index'
> > ../include/linux/of.h:1193: warning: Excess function parameter
> > 'out_string' description in 'of_property_read_string_index'
> > ../include/linux/of.h:1461: warning: cannot understand function
> > prototype: 'enum of_overlay_notify_action '
> > ../drivers/of/base.c:1781: warning: Excess function parameter 'prob'
> > description in '__of_add_property'
> > ../drivers/of/base.c:1804: warning: Excess function parameter 'prob'
> > description in 'of_add_property'
> > ../drivers/of/base.c:1855: warning: Function parameter or member
> > 'prop' not described in 'of_remove_property'
> > ../drivers/of/base.c:1855: warning: Excess function parameter 'prob'
> > description in 'of_remove_property'
>
> You don't want much do you! ;)
Hey, want to fix all the schema warnings for me? ;)
>
> Sure, I plan to clean up all of the kernel with subsequent patches.
>
> > BTW, there some more which I guess W=1 doesn't find:
> >
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:906: WARNING: Block quote ends without a blank
> > line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1465: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1469: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1473: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1517: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1521: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1526: WARNING: Unexpected indentation.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1528: WARNING: Block quote ends without a blank
> > line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1529: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1533: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > ../drivers/of/base.c:1705: WARNING: Definition list ends without a
> > blank line; unexpected unindent.
> > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:49:
> > ../drivers/of/overlay.c:1183: WARNING: Inline emphasis start-string
> > without end-string.
>
> What command did you use to find these?
make htmldocs
(with the DT files added to the docs)
These turn out to be the tip of the iceberg. There's all sorts of
formatting issues. Tabs are a problem and the 'Return' section is
wrong. These are only found looking at the output.
Rob
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 00/10] Rid W=1 warnings from OF
2021-03-24 14:09 ` Rob Herring
@ 2021-03-24 15:12 ` Lee Jones
0 siblings, 0 replies; 7+ messages in thread
From: Lee Jones @ 2021-03-24 15:12 UTC (permalink / raw)
To: Rob Herring
Cc: linux-kernel@vger.kernel.org, Andrew Lunn, Anton Vorontsov,
Benjamin Herrenschmidt, Colin Cross, David S. Miller, devicetree,
Frank Rowand, Heiner Kallweit, Josh Cartwright, Kees Cook,
Marek Szyprowski, netdev, Pantelis Antoniou, Russell King,
Tony Luck
On Wed, 24 Mar 2021, Rob Herring wrote:
> On Tue, Mar 23, 2021 at 2:36 AM Lee Jones <lee.jones@linaro.org> wrote:
> >
> > On Mon, 22 Mar 2021, Rob Herring wrote:
> >
> > > On Thu, Mar 18, 2021 at 4:40 AM Lee Jones <lee.jones@linaro.org> wrote:
> > > >
> > > > 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.
> > > >
> > > > v2:
> > > > - Provided some descriptions to exported functions
> > > >
> > > > Lee Jones (10):
> > > > of: device: Fix function name in header and provide missing
> > > > descriptions
> > > > of: dynamic: Fix incorrect parameter name and provide missing
> > > > descriptions
> > > > of: platform: Demote kernel-doc abuse
> > > > of: base: Fix some formatting issues and provide missing descriptions
> > > > of: property: Provide missing member description and remove excess
> > > > param
> > > > of: address: Provide descriptions for 'of_address_to_resource's params
> > > > of: fdt: Demote kernel-doc abuses and fix function naming
> > > > of: of_net: Provide function name and param description
> > > > of: overlay: Fix function name disparity
> > > > of: of_reserved_mem: Demote kernel-doc abuses
> > > >
> > > > drivers/of/address.c | 3 +++
> > > > drivers/of/base.c | 16 +++++++++++-----
> > > > drivers/of/device.c | 7 ++++++-
> > > > drivers/of/dynamic.c | 4 +++-
> > > > drivers/of/fdt.c | 23 ++++++++++++-----------
> > > > drivers/of/of_net.c | 3 +++
> > > > 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, 44 insertions(+), 24 deletions(-)
> > >
> > > I still see some warnings (note this is with DT files added to doc
> > > build). Can you send follow-up patches:
> > >
> > > ../include/linux/of.h:1193: warning: Function parameter or member
> > > 'output' not described in 'of_property_read_string_index'
> > > ../include/linux/of.h:1193: warning: Excess function parameter
> > > 'out_string' description in 'of_property_read_string_index'
> > > ../include/linux/of.h:1461: warning: cannot understand function
> > > prototype: 'enum of_overlay_notify_action '
> > > ../drivers/of/base.c:1781: warning: Excess function parameter 'prob'
> > > description in '__of_add_property'
> > > ../drivers/of/base.c:1804: warning: Excess function parameter 'prob'
> > > description in 'of_add_property'
> > > ../drivers/of/base.c:1855: warning: Function parameter or member
> > > 'prop' not described in 'of_remove_property'
> > > ../drivers/of/base.c:1855: warning: Excess function parameter 'prob'
> > > description in 'of_remove_property'
> >
> > You don't want much do you! ;)
>
> Hey, want to fix all the schema warnings for me? ;)
Definitely not. I've even gone to the trouble of disabling them. :D
> > Sure, I plan to clean up all of the kernel with subsequent patches.
> >
> > > BTW, there some more which I guess W=1 doesn't find:
> > >
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:906: WARNING: Block quote ends without a blank
> > > line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1465: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1469: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1473: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1517: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1521: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1526: WARNING: Unexpected indentation.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1528: WARNING: Block quote ends without a blank
> > > line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1529: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1533: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:19:
> > > ../drivers/of/base.c:1705: WARNING: Definition list ends without a
> > > blank line; unexpected unindent.
> > > /home/rob/proj/git/linux-dt/Documentation/driver-api/devicetree:49:
> > > ../drivers/of/overlay.c:1183: WARNING: Inline emphasis start-string
> > > without end-string.
> >
> > What command did you use to find these?
>
> make htmldocs
>
> (with the DT files added to the docs)
>
> These turn out to be the tip of the iceberg. There's all sorts of
> formatting issues. Tabs are a problem and the 'Return' section is
> wrong. These are only found looking at the output.
Heh! Depends how desperate I get. :'D
--
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] 7+ messages in thread
end of thread, other threads:[~2021-03-24 15:13 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-18 10:40 ` [PATCH 08/10] of: of_net: Provide function name and param description Lee Jones
2021-03-18 13:10 ` Andrew Lunn
2021-03-22 22:22 ` [PATCH v2 00/10] Rid W=1 warnings from OF Rob Herring
2021-03-23 8:36 ` Lee Jones
2021-03-24 14:09 ` Rob Herring
2021-03-24 15:12 ` 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).