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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <49aec9dffbd9cf4d1ea0efe9d3cb36afb3e31aea.camel@sipsolutions.net>
Date: Fri, 15 Nov 2024 17:45:39 +0100
From: Johannes Berg <johannes@...solutions.net>
To: Jakub Kicinski <kuba@...nel.org>, davem@...emloft.net
Cc: netdev@...r.kernel.org, edumazet@...gle.com, pabeni@...hat.com, 
	pablo@...filter.org, linux@...linux.org.uk, richardcochran@...il.com, 
	loic.poulain@...aro.org, ryazanov.s.a@...il.com, dsahern@...nel.org, 
	wintera@...ux.ibm.com, hawk@...nel.org, ilias.apalodimas@...aro.org, 
	jhs@...atatu.com, jiri@...nulli.us, ecree.xilinx@...il.com, 
	przemyslaw.kitszel@...el.com, netfilter-devel@...r.kernel.org, 
	linux-wireless@...r.kernel.org
Subject: Re: [PATCH net-next] net: reformat kdoc return statements

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@...solutions.net>

johannes