Re: [PATCH 26/30] net: wireless: broadcom: b43: phy_common: Demote non-conformant kerneldoc header
From: Lee Jones <hidden>
Date: 2020-08-17 09:12:02
Also in:
linux-wireless, lkml
Possibly related (same subject, not in this thread)
- 2020-08-14 · Re: [PATCH 26/30] net: wireless: broadcom: b43: phy_common: Demote non-conformant kerneldoc header · Lee Jones <hidden>
On Mon, 17 Aug 2020, Rafał Miłecki wrote:
On Fri, 14 Aug 2020 at 13:41, Lee Jones [off-list ref] wrote:quoted
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