lkml.org 
[lkml]   [2020]   [Aug]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 26/30] net: wireless: broadcom: b43: phy_common: Demote non-conformant kerneldoc header
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

\
 
 \ /
  Last update: 2020-08-17 11:12    [W:0.132 / U:0.748 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site