Message ID | 20200814113933.1903438-27-lee.jones@linaro.org (mailing list archive) |
---|---|
State | Accepted |
Commit | c171304b42f9d6e21191ca9204a86cc32023a2fe |
Delegated to: | Kalle Valo |
Headers | show |
Series | None | expand |
On Fri, 14 Aug 2020, Artur Dubrovsky wrote: > remove me from mailing list I guess you have to remove yourself: http://lists.infradead.org/mailman/listinfo/b43-dev > пт, 14 авг. 2020 г. в 14:43, Lee Jones <lee.jones@linaro.org>: > > > 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' > > > > Cc: Kalle Valo <kvalo@codeaurora.org> > > Cc: "David S. Miller" <davem@davemloft.net> > > Cc: Jakub Kicinski <kuba@kernel.org> > > Cc: "Alexander A. Klimov" <grandmaster@al2klimov.de> > > Cc: Martin Langer <martin-langer@gmx.de> > > Cc: Stefano Brivio <stefano.brivio@polimi.it> > > Cc: Michael Buesch <m@bues.ch> > > Cc: van Dyk <kugelfang@gentoo.org> > > Cc: Andreas Jaggi <andreas.jaggi@waterwave.ch> > > Cc: linux-wireless@vger.kernel.org > > Cc: b43-dev@lists.infradead.org > > Cc: netdev@vger.kernel.org > > Signed-off-by: Lee Jones <lee.jones@linaro.org> > > --- > > drivers/net/wireless/broadcom/b43/phy_common.c | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) [...]
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.
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.
diff --git a/drivers/net/wireless/broadcom/b43/phy_common.c b/drivers/net/wireless/broadcom/b43/phy_common.c index 1de4de094d61b..285490f6f0a1d 100644 --- a/drivers/net/wireless/broadcom/b43/phy_common.c +++ b/drivers/net/wireless/broadcom/b43/phy_common.c @@ -458,7 +458,7 @@ void b43_software_rfkill(struct b43_wldev *dev, bool blocked) b43_mac_enable(dev); } -/** +/* * b43_phy_txpower_adjust_work - TX power workqueue. * * Workqueue for updating the TX power parameters in hardware.
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' Cc: Kalle Valo <kvalo@codeaurora.org> Cc: "David S. Miller" <davem@davemloft.net> Cc: Jakub Kicinski <kuba@kernel.org> Cc: "Alexander A. Klimov" <grandmaster@al2klimov.de> Cc: Martin Langer <martin-langer@gmx.de> Cc: Stefano Brivio <stefano.brivio@polimi.it> Cc: Michael Buesch <m@bues.ch> Cc: van Dyk <kugelfang@gentoo.org> Cc: Andreas Jaggi <andreas.jaggi@waterwave.ch> Cc: linux-wireless@vger.kernel.org Cc: b43-dev@lists.infradead.org Cc: netdev@vger.kernel.org Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/net/wireless/broadcom/b43/phy_common.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)