From: Rob Herring <robh+dt@kernel.org>
To: Lee Jones <lee.jones@linaro.org>
Cc: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Andrew Lunn <andrew@lunn.ch>, Anton Vorontsov <anton@enomsg.org>,
Benjamin Herrenschmidt <benh@kernel.crashing.org>,
Colin Cross <ccross@android.com>,
"David S. Miller" <davem@davemloft.net>,
devicetree@vger.kernel.org, Frank Rowand <frowand.list@gmail.com>,
Heiner Kallweit <hkallweit1@gmail.com>,
Josh Cartwright <joshc@codeaurora.org>,
Kees Cook <keescook@chromium.org>,
Marek Szyprowski <m.szyprowski@samsung.com>,
netdev <netdev@vger.kernel.org>,
Pantelis Antoniou <pantelis.antoniou@konsulko.com>,
Russell King <linux@armlinux.org.uk>,
Tony Luck <tony.luck@intel.com>
Subject: Re: [PATCH v2 00/10] Rid W=1 warnings from OF
Date: Wed, 24 Mar 2021 08:09:04 -0600 [thread overview]
Message-ID: <CAL_JsqL_V-BgZpSCLL4JQHF3OC-60RPeExkDLf-uSohnpcBdOA@mail.gmail.com> (raw)
In-Reply-To: <20210323083631.GE2916463@dell>
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
next prev parent reply other threads:[~2021-03-24 14:10 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-18 10:40 ` [PATCH 01/10] of: device: Fix function name in header and provide missing descriptions Lee Jones
2021-03-18 10:40 ` [PATCH 02/10] of: dynamic: Fix incorrect parameter name " Lee Jones
2021-03-18 10:40 ` [PATCH 03/10] of: platform: Demote kernel-doc abuse Lee Jones
2021-03-18 10:40 ` [PATCH 04/10] of: base: Fix some formatting issues and provide missing descriptions Lee Jones
2021-03-18 10:40 ` [PATCH 05/10] of: property: Provide missing member description and remove excess param Lee Jones
2021-03-18 10:40 ` [PATCH 06/10] of: address: Provide descriptions for 'of_address_to_resource's params Lee Jones
2021-03-18 10:40 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses and fix function naming 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-18 10:40 ` [PATCH 09/10] of: overlay: Fix function name disparity Lee Jones
2021-03-18 10:40 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones
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 [this message]
2021-03-24 15:12 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAL_JsqL_V-BgZpSCLL4JQHF3OC-60RPeExkDLf-uSohnpcBdOA@mail.gmail.com \
--to=robh+dt@kernel.org \
--cc=andrew@lunn.ch \
--cc=anton@enomsg.org \
--cc=benh@kernel.crashing.org \
--cc=ccross@android.com \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=frowand.list@gmail.com \
--cc=hkallweit1@gmail.com \
--cc=joshc@codeaurora.org \
--cc=keescook@chromium.org \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=m.szyprowski@samsung.com \
--cc=netdev@vger.kernel.org \
--cc=pantelis.antoniou@konsulko.com \
--cc=tony.luck@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).