Search Linux Wireless

Re: [PATCH net-next] net: reformat kdoc return statements

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, 2024-11-15 at 08:36 -0800, Jakub Kicinski wrote:
> kernel-doc -Wall warns about missing Return: statement for non-void
> functions. We have a number of kdocs in our headers which are missing
> the colon, IOW they use
>  * Return some value
> or
>  * Returns some value
> 
> Having the colon makes some sense, it should help kdoc parser avoid
> false positives. So add them. This is mostly done with a sed script,
> and removing the unnecessary cases (mostly the comments which aren't
> kdoc).

Sure, I thought we were running kernel-doc pretty strictly now, but I
guess there's always something to add :)

LGTM. I guess some like e.g. netif_attrmask_next_and() could also get
just more docs in general, in that example have something like "returns
the next set bit or >= nr_bits if ..." but that's really unrelated.

As far as wireless is concerned:

>  include/linux/rfkill.h             |  2 +-
> 
>  include/net/cfg80211.h             |  2 +-
> 
>  include/net/mac80211.h             |  2 +-

Acked-by: Johannes Berg <johannes@xxxxxxxxxxxxxxxx>

johannes





[Index of Archives]     [Linux Host AP]     [ATH6KL]     [Linux Wireless Personal Area Network]     [Linux Bluetooth]     [Wireless Regulations]     [Linux Netdev]     [Kernel Newbies]     [Linux Kernel]     [IDE]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite Hiking]     [MIPS Linux]     [ARM Linux]     [Linux RAID]

  Powered by Linux