[PATCH 2/3] netfilter: add missing kernel-doc parameters for nf_hook()

[PATCH 2/3] netfilter: add missing kernel-doc parameters for nf_hook()

[Kit Dallege]

Document all 8 parameters of nf_hook() that were missing from the
kernel-doc comment.

Assisted-by: Claude <noreply@anthropic.com>
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 include/linux/netfilter.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/linux/netfilter.h b/include/linux/netfilter.h
index efbbfa770d66..a67fa43955bd 100644
--- a/include/linux/netfilter.h
+++ b/include/linux/netfilter.h
@@ -219,6 +219,14 @@ void nf_hook_slow_list(struct list_head *head, struct nf_hook_state *state,
 		       const struct nf_hook_entries *e);
 /**
  *	nf_hook - call a netfilter hook
+ *	@pf:	protocol family (e.g. NFPROTO_IPV4)
+ *	@hook:	hook number (e.g. NF_INET_PRE_ROUTING)
+ *	@net:	network namespace
+ *	@sk:	socket associated with the packet, or NULL
+ *	@skb:	socket buffer holding the packet
+ *	@indev:	input network device, or NULL
+ *	@outdev: output network device, or NULL
+ *	@okfn:	function to call if the hook allows the packet to pass
  *
  *	Returns 1 if the hook has allowed the packet to pass.  The function
  *	okfn must be invoked by the caller in this case.  Any other return
-- 
2.53.0

Re: [PATCH 2/3] netfilter: add missing kernel-doc parameters for nf_hook()

[Florian Westphal]

Kit Dallege <xaum.io@gmail.com> wrote:
>  /**
>   *	nf_hook - call a netfilter hook
> + *	@pf:	protocol family (e.g. NFPROTO_IPV4)
> + *	@hook:	hook number (e.g. NF_INET_PRE_ROUTING)
> + *	@net:	network namespace
> + *	@sk:	socket associated with the packet, or NULL
> + *	@skb:	socket buffer holding the packet
> + *	@indev:	input network device, or NULL
> + *	@outdev: output network device, or NULL
> + *	@okfn:	function to call if the hook allows the packet to pass
>   *

I tend towards not applying this, I don't think this adds any value,
the arguments are rather obvious for anyone doing kernel networking
and its not a utility/library function either.