netdev - Re: [PATCH net-next v2] 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: <Z1LPaoazEajgMhp_@calendula>
Date: Fri, 6 Dec 2024 11:18:18 +0100
From: Pablo Neira Ayuso <pablo@...filter.org>
To: Jakub Kicinski <kuba@...nel.org>
Cc: davem@...emloft.net, netdev@...r.kernel.org, edumazet@...gle.com,
	pabeni@...hat.com, Johannes Berg <johannes@...solutions.net>,
	Richard Cochran <richardcochran@...il.com>,
	Sergey Ryazanov <ryazanov.s.a@...il.com>,
	Edward Cree <ecree.xilinx@...il.com>,
	Alexandra Winter <wintera@...ux.ibm.com>, loic.poulain@...aro.org,
	dsahern@...nel.org, hawk@...nel.org, ilias.apalodimas@...aro.org,
	jhs@...atatu.com, jiri@...nulli.us, przemyslaw.kitszel@...el.com,
	netfilter-devel@...r.kernel.org, linux-wireless@...r.kernel.org
Subject: Re: [PATCH net-next v2] net: reformat kdoc return statements

On Thu, Dec 05, 2024 at 08:59:14AM -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).
> 
> Acked-by: Johannes Berg <johannes@...solutions.net>
> Acked-by: Richard Cochran <richardcochran@...il.com>
> Acked-by: Sergey Ryazanov <ryazanov.s.a@...il.com>
> Reviewed-by: Edward Cree <ecree.xilinx@...il.com>
> Acked-by: Alexandra Winter <wintera@...ux.ibm.com>
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>

For the netfilter chunks:

Acked-by: Pablo Neira Ayuso <pablo@...filter.org>