]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
net: reformat kdoc return statements
authorJakub Kicinski <kuba@kernel.org>
Thu, 5 Dec 2024 16:59:14 +0000 (08:59 -0800)
committerJakub Kicinski <kuba@kernel.org>
Mon, 9 Dec 2024 22:44:59 +0000 (14:44 -0800)
commit3f330db30638b6489d548084a7e8843374d41ad0
tree37a71dc8f18ddd2cc87d0dd95b1440a5148f8599
parentca7858880590d4f1dfe73b2cbf372b8ed80a6d81
net: reformat kdoc return statements

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@sipsolutions.net>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Acked-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
Reviewed-by: Edward Cree <ecree.xilinx@gmail.com>
Acked-by: Alexandra Winter <wintera@linux.ibm.com>
Acked-by: Pablo Neira Ayuso <pablo@netfilter.org>
Link: https://patch.msgid.link/20241205165914.1071102-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
21 files changed:
include/linux/etherdevice.h
include/linux/ethtool.h
include/linux/if_vlan.h
include/linux/netdevice.h
include/linux/netfilter/x_tables.h
include/linux/netfilter_netdev.h
include/linux/ptp_clock_kernel.h
include/linux/rfkill.h
include/linux/rtnetlink.h
include/linux/skbuff.h
include/linux/wwan.h
include/net/cfg80211.h
include/net/dst.h
include/net/genetlink.h
include/net/ipv6.h
include/net/iucv/iucv.h
include/net/netfilter/nf_tproxy.h
include/net/netlink.h
include/net/page_pool/helpers.h
include/net/pkt_cls.h
include/net/tcp.h