Skip to contentSkip to conversation

netfilter: Add missing Kernel doc to headers

PATCH In review Simon Horman 3 participants 7 messages Aug 30, 2024 – Sep 3, 2024

Subsystems (3)
lore
Share & tools
lore

Simon Horman

author reviewer
#0 lore raw

cover netfilter: Add missing Kernel doc to headers

Hi,

This short series addresses some minor Kernel doc problems in Netfilter header files.

---
Simon Horman (2):
netfilter: nf_tables: Add missing Kernel doc to nf_tables.h
netfilter: tproxy: Add missing Kernel doc to nf_tproxy.h

 include/net/netfilter/nf_tables.h | 2 ++
 include/net/netfilter/nf_tproxy.h | 1 +
 2 files changed, 3 insertions(+)

base-commit: d2ab3bb890f6a88facf89494ce50b27ff8236d24

author reviewer
#1 lore raw

PATCH 1/2 netfilter: nf_tables: Add missing Kernel doc to nf_tables.h

Add missing documentation of struct field and enum items.

Flagged by ./scripts/kernel-doc -none.

No functional change intended.
Compile tested only.

---
 include/net/netfilter/nf_tables.h | 2 ++
 1 file changed, 2 insertions(+)
include/net/netfilter/nf_tables.h +2 -0
index 1cc33d946d41..12ae0434ac93 100644
@@ -209,6 +209,7 @@ static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
  *	@family: protocol family
  *	@level: depth of the chains
  *	@report: notify via unicast netlink message
+ *	@reg_inited: bitmap of initialised registers
  */
 struct nft_ctx {
 	struct net			*net;
@@ -313,6 +314,7 @@ static inline void *nft_elem_priv_cast(const struct nft_elem_priv *priv)
 /**
  * enum nft_iter_type - nftables set iterator type
  *
+ * @NFT_ITER_UNSPEC: unspecified, to catch errors
  * @NFT_ITER_READ: read-only iteration over set elements
  * @NFT_ITER_UPDATE: iteration under mutex to update set element state
  */
Signature · 1 line
2.45.2
author reviewer
#2 lore raw

PATCH 2/2 netfilter: tproxy: Add missing Kernel doc to nf_tproxy.h

In reply to Simon Horman

Add missing documentation of function parameter.

Flagged by ./scripts/kernel-doc -none.

No functional change intended.
Compile tested only.

---
 include/net/netfilter/nf_tproxy.h | 1 +
 1 file changed, 1 insertion(+)
include/net/netfilter/nf_tproxy.h +1 -0
index faa108b1ba67..5adf6fda11e8 100644
@@ -36,6 +36,7 @@ __be32 nf_tproxy_laddr4(struct sk_buff *skb, __be32 user_laddr, __be32 daddr);
 
 /**
  * nf_tproxy_handle_time_wait4 - handle IPv4 TCP TIME_WAIT reopen redirections
+ * @net:	The network namespace.
  * @skb:	The skb being processed.
  * @laddr:	IPv4 address to redirect to or zero.
  * @lport:	TCP port to redirect to or zero.
Signature · 1 line
2.45.2
#4 lore raw
Quoted 9 lines · Florian Westphal
Quoted 4 lines · Simon Horman

Hi,

This short series addresses some minor Kernel doc problems in Netfilter header files.

Thanks Simon, this looks good to me.
Series:

Thanks for reviewing.

If you both don't mind, I am going to collapse the three pending patches from Simon that are targeting kdoc stuff.

author reviewer
#5 lore raw
Quoted 7 lines · Pablo Neira Ayuso
Quoted 6 lines · Florian Westphal
Quoted 4 lines · Simon Horman

Hi,

This short series addresses some minor Kernel doc problems in Netfilter header files.

Quoted 8 lines
Quoted 3 lines

Thanks Simon, this looks good to me.
Series:

Thanks for reviewing.

If you both don't mind, I am going to collapse the three pending patches from Simon that are targeting kdoc stuff.

Thanks Pablo,

No problem with that from my side.

#6 lore raw
Quoted 12 lines · Simon Horman
Quoted 11 lines · Pablo Neira Ayuso
Quoted 9 lines · Florian Westphal
Quoted 4 lines · Simon Horman

Hi,

This short series addresses some minor Kernel doc problems in Netfilter header files.

Thanks Simon, this looks good to me.
Series:

Quoted 8 lines
Quoted 4 lines

Thanks for reviewing.

If you both don't mind, I am going to collapse the three pending patches from Simon that are targeting kdoc stuff.

Thanks Pablo,

No problem with that from my side.

Thanks Simon, I have collapsed these two patches.