From: Lee Jones <lee.jones@linaro.org>
To: "Rafał Miłecki" <zajec5@gmail.com>
Cc: David Miller <davem@davemloft.net>,
kuba@kernel.org, Michael Buesch <m@bues.ch>,
Stefano Brivio <stefano.brivio@polimi.it>,
Andreas Jaggi <andreas.jaggi@waterwave.ch>,
Network Development <netdev@vger.kernel.org>,
"linux-wireless@vger.kernel.org" <linux-wireless@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
b43-dev <b43-dev@lists.infradead.org>,
"Alexander A. Klimov" <grandmaster@al2klimov.de>,
Martin Langer <martin-langer@gmx.de>,
van Dyk <kugelfang@gentoo.org>, Kalle Valo <kvalo@codeaurora.org>
Subject: Re: [PATCH 26/30] net: wireless: broadcom: b43: phy_common: Demote non-conformant kerneldoc header
Date: Mon, 17 Aug 2020 10:11:39 +0100 [thread overview]
Message-ID: <20200817091139.GU4354@dell> (raw)
In-Reply-To: <CACna6ryNNyyVftEFNFEwouKc3O21oPaeqie+bjJR4L_Cf8z2BQ@mail.gmail.com>
On Mon, 17 Aug 2020, Rafał Miłecki wrote:
> On Fri, 14 Aug 2020 at 13:41, Lee Jones <lee.jones@linaro.org> wrote:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/net/wireless/broadcom/b43/phy_common.c:467: warning: Function parameter or member 'work' not described in 'b43_phy_txpower_adjust_work'
>
> Why you can't document @work instead? Should be quite a better solution.
It some circumstances it would, but not this one.
1. This 'kernel-doc' function is not referenced from any
documentation location i.e. it is presently unused and there is no
reason for it to be kernel-doc in the first place.
2. This patch stops `scripts/find-unused-docs.sh` complaining about
phy_common.c
3. 'b43_phy_txpower_adjust_work' is the only function that has been
documented as kernel-doc - why is that? Seems like a mistake.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
next prev parent reply other threads:[~2020-08-17 9:11 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200814113933.1903438-1-lee.jones@linaro.org>
2020-08-14 11:39 ` [PATCH 05/30] net: wireless: atmel: atmel: Demote non-kerneldoc header to standard comment block Lee Jones
2020-08-27 12:16 ` [PATCH 05/30] " Kalle Valo
2020-08-14 11:39 ` [PATCH 07/30] net: wireless: broadcom: b43: main: Add braces around empty statements Lee Jones
2020-08-14 15:12 ` Kalle Valo
2020-08-14 16:43 ` Lee Jones
2020-08-14 17:25 ` Kalle Valo
2020-08-17 8:50 ` Lee Jones
2020-08-27 7:42 ` Kalle Valo
2020-08-27 8:49 ` Lee Jones
2020-08-14 11:39 ` [PATCH 08/30] net: wireless: ath: carl9170: Mark 'ar9170_qmap' as __maybe_unused Lee Jones
2020-08-14 15:14 ` Christian Lamparter
2020-08-14 16:40 ` Lee Jones
2020-08-14 17:25 ` Christian Lamparter
2020-08-17 8:43 ` Lee Jones
2020-08-17 8:26 ` Rasmus Villemoes
2020-08-17 12:59 ` Kalle Valo
2020-08-17 18:29 ` Christian Lamparter
2020-08-18 9:50 ` Lee Jones
2020-08-27 7:54 ` Kalle Valo
2020-08-27 9:33 ` [PATCH v2 08/30] net: wireless: ath: carl9170: Convert 'ar9170_qmap' to inline function Lee Jones
2020-08-28 20:28 ` Christian Lamparter
2020-08-31 13:56 ` Kalle Valo
2020-08-31 15:19 ` Kalle Valo
2020-08-14 11:39 ` [PATCH 09/30] net: wireless: ath: ath5k: pcu: Add a description for 'band' remove one for 'mode' Lee Jones
2020-08-17 10:20 ` Kalle Valo
2020-08-14 11:39 ` [PATCH 11/30] net: wireless: cisco: airo: Place brackets around empty statement Lee Jones
2020-08-14 11:39 ` [PATCH 12/30] net: wireless: cisco: airo: Fix a myriad of coding style issues Lee Jones
2020-08-14 15:15 ` Kalle Valo
2020-08-14 16:38 ` Lee Jones
2020-08-17 13:27 ` Kalle Valo
2020-08-17 18:27 ` Jesse Brandeburg
2020-08-17 20:04 ` Lee Jones
2020-08-17 21:35 ` Ondrej Zary
2020-08-27 7:49 ` Kalle Valo
2020-08-27 20:23 ` Ondrej Zary
2020-08-28 8:59 ` Kalle Valo
2020-08-28 10:08 ` Lee Jones
2020-08-28 12:37 ` Kalle Valo
2020-08-28 21:34 ` Ondrej Zary
2020-08-14 11:39 ` [PATCH 13/30] net: wireless: ath: wil6210: cfg80211: Demote non-kerneldoc headers to standard comment blocks Lee Jones
2020-08-14 11:39 ` [PATCH 14/30] net: wireless: intel: iwlegacy: common: Remove set but not used variable 'len' Lee Jones
2020-08-14 11:39 ` [PATCH 15/30] net: wireless: intel: iwlegacy: common: Demote kerneldoc headers to standard comment blocks Lee Jones
2020-08-14 11:39 ` [PATCH 16/30] net: wireless: intel: ipw2200: Remove set but unused variables 'rc' and 'w' Lee Jones
2020-08-14 11:39 ` [PATCH 17/30] net: wireless: broadcom: b43legacy: main: Provide braces around empty 'if' body Lee Jones
2020-08-14 11:39 ` [PATCH 20/30] net: wireless: ath: ath5k: base: Fix kerneldoc formatting issue Lee Jones
2020-08-14 11:39 ` [PATCH 22/30] net: wireless: broadcom: brcm80211: brcmfmac: fweh: Remove set but unused variable 'err' Lee Jones
2020-08-14 11:39 ` [PATCH 23/30] net: wireless: broadcom: brcm80211: brcmfmac: fweh: Fix docrot related function documentation issues Lee Jones
2020-08-14 11:39 ` [PATCH 24/30] net: wireless: broadcom: brcm80211: brcmsmac: mac80211_if: Demote a few non-conformant kerneldoc headers Lee Jones
2020-08-14 11:39 ` [PATCH 25/30] net: wireless: intel: ipw2x00: ipw2200: Demote lots of nonconformant kerneldoc comments Lee Jones
2020-08-14 11:39 ` [PATCH 26/30] net: wireless: broadcom: b43: phy_common: Demote non-conformant kerneldoc header Lee Jones
[not found] ` <CAJrvBf00yQQ7F1p1utBuq1oWc2RwnqXijBjaJ+FuxG0mS0TvOA@mail.gmail.com>
2020-08-14 16:36 ` Lee Jones
2020-08-17 8:06 ` Rafał Miłecki
2020-08-17 9:11 ` Lee Jones [this message]
2020-08-14 11:39 ` [PATCH 30/30] net: wireless: broadcom: b43: phy_n: Add empty braces around empty statements Lee Jones
[not found] ` <87eeo88pdr.fsf@tynnyri.adurom.net>
2020-08-17 8:16 ` [PATCH 00/30] Rid W=1 warnings in Networking 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=20200817091139.GU4354@dell \
--to=lee.jones@linaro.org \
--cc=andreas.jaggi@waterwave.ch \
--cc=b43-dev@lists.infradead.org \
--cc=davem@davemloft.net \
--cc=grandmaster@al2klimov.de \
--cc=kuba@kernel.org \
--cc=kugelfang@gentoo.org \
--cc=kvalo@codeaurora.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=m@bues.ch \
--cc=martin-langer@gmx.de \
--cc=netdev@vger.kernel.org \
--cc=stefano.brivio@polimi.it \
--cc=zajec5@gmail.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).