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

From
Johannes Berg <johannes@sipsolutions.net>
Date
2024-11-15 16:45:56
Also in
linux-wireless, netfilter-devel
Reply to
Jakub Kicinski, 2024-11-15
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@sipsolutions.net>

johannes
Thread (10 messages) 10 messages, 8 authors, last reply 2024-11-19
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help