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

From
Alexandra Winter <wintera@linux.ibm.com>
Date
2024-11-19 09:08:15
Also in
linux-wireless, netfilter-devel
Reply to
Jakub Kicinski, 2024-11-15

On 15.11.24 17:36, 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@kernel.org>
---
LMK if I should have split this into smaller chunks, I don't really
expect much review here, TBH.
---
CC: pablo@netfilter.org
CC: linux@armlinux.org.uk
CC: richardcochran@gmail.com
CC: johannes@sipsolutions.net
CC: <redacted>
CC: ryazanov.s.a@gmail.com
CC: dsahern@kernel.org
CC: wintera@linux.ibm.com
[...]
 include/net/iucv/iucv.h            | 30 ++++++++++----------

Thank you Jakub.
For the iucv part:
Acked-by: Alexandra Winter <wintera@linux.ibm.com>
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