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: <Zzir9EH83f2jRgQU@hoboy.vegasvil.org>
Date: Sat, 16 Nov 2024 06:28:04 -0800
From: Richard Cochran <richardcochran@...il.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: davem@...emloft.net, netdev@...r.kernel.org, edumazet@...gle.com,
	pabeni@...hat.com, pablo@...filter.org, linux@...linux.org.uk,
	johannes@...solutions.net, 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, Nov 15, 2024 at 08:36:12AM -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).
> 
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>
> ---
> LMK if I should have split this into smaller chunks, I don't really
> expect much review here, TBH.
> ---
> CC: pablo@...filter.org
> CC: linux@...linux.org.uk
> CC: richardcochran@...il.com

Acked-by: Richard Cochran <richardcochran@...il.com>