[PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[Simon Horman]

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

[PATCH nf-next 1/2] netfilter: nf_tables: Add missing Kernel doc to nf_tables.h

[Simon Horman]

Add missing documentation of struct field and enum items.

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

No functional change intended.
Compile tested only.

Signed-off-by: Simon Horman <horms@kernel.org>
---
 include/net/netfilter/nf_tables.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/net/netfilter/nf_tables.h b/include/net/netfilter/nf_tables.h
index 1cc33d946d41..12ae0434ac93 100644
--- a/include/net/netfilter/nf_tables.h
+++ b/include/net/netfilter/nf_tables.h
@@ -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
  */

-- 
2.45.2

[PATCH nf-next 2/2] netfilter: tproxy: Add missing Kernel doc to nf_tproxy.h

[Simon Horman]

Add missing documentation of function parameter.

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

No functional change intended.
Compile tested only.

Signed-off-by: Simon Horman <horms@kernel.org>
---
 include/net/netfilter/nf_tproxy.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/net/netfilter/nf_tproxy.h b/include/net/netfilter/nf_tproxy.h
index faa108b1ba67..5adf6fda11e8 100644
--- a/include/net/netfilter/nf_tproxy.h
+++ b/include/net/netfilter/nf_tproxy.h
@@ -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.

-- 
2.45.2

Re: [PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[Florian Westphal]

Simon Horman <horms@kernel.org> wrote:
> Hi,
> 
> This short series addresses some minor Kernel doc problems
> in Netfilter header files.

Thanks Simon, this looks good to me.
Series:
Reviewed-by: Florian Westphal <fw@strlen.de>

Re: [PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[Pablo Neira Ayuso]

On Sat, Aug 31, 2024 at 10:03:07PM +0200, Florian Westphal wrote:
> Simon Horman <horms@kernel.org> wrote:
> > Hi,
> > 
> > This short series addresses some minor Kernel doc problems
> > in Netfilter header files.
> 
> Thanks Simon, this looks good to me.
> Series:
> Reviewed-by: Florian Westphal <fw@strlen.de>

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.

Re: [PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[Simon Horman]

On Sun, Sep 01, 2024 at 10:07:27PM +0200, Pablo Neira Ayuso wrote:
> On Sat, Aug 31, 2024 at 10:03:07PM +0200, Florian Westphal wrote:
> > Simon Horman <horms@kernel.org> wrote:
> > > Hi,
> > > 
> > > This short series addresses some minor Kernel doc problems
> > > in Netfilter header files.
> > 
> > Thanks Simon, this looks good to me.
> > Series:
> > Reviewed-by: Florian Westphal <fw@strlen.de>
> 
> 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.

Re: [PATCH nf-next 0/2] netfilter: Add missing Kernel doc to headers

[Pablo Neira Ayuso]

On Mon, Sep 02, 2024 at 10:25:59AM +0100, Simon Horman wrote:
> On Sun, Sep 01, 2024 at 10:07:27PM +0200, Pablo Neira Ayuso wrote:
> > On Sat, Aug 31, 2024 at 10:03:07PM +0200, Florian Westphal wrote:
> > > Simon Horman <horms@kernel.org> wrote:
> > > > Hi,
> > > > 
> > > > This short series addresses some minor Kernel doc problems
> > > > in Netfilter header files.
> > > 
> > > Thanks Simon, this looks good to me.
> > > Series:
> > > Reviewed-by: Florian Westphal <fw@strlen.de>
> > 
> > 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.