From: Lee Jones <lee.jones@linaro.org>
To: Andrew Lunn <andrew@lunn.ch>
Cc: linux-kernel@vger.kernel.org,
Heiner Kallweit <hkallweit1@gmail.com>,
Russell King <linux@armlinux.org.uk>,
Rob Herring <robh+dt@kernel.org>,
Frank Rowand <frowand.list@gmail.com>,
netdev@vger.kernel.org, devicetree@vger.kernel.org
Subject: Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
Date: Fri, 12 Mar 2021 15:18:09 +0000 [thread overview]
Message-ID: <20210312151809.GW701493@dell> (raw)
In-Reply-To: <YEt1GlakFcST27F0@lunn.ch>
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
prev parent reply other threads:[~2021-03-12 15:19 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 message]
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=20210312151809.GW701493@dell \
--to=lee.jones@linaro.org \
--cc=andrew@lunn.ch \
--cc=devicetree@vger.kernel.org \
--cc=frowand.list@gmail.com \
--cc=hkallweit1@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=netdev@vger.kernel.org \
--cc=robh+dt@kernel.org \
/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).