[PATCH net-next] linux/netfilter.h: fix kernel-doc warnings

[PATCH net-next] linux/netfilter.h: fix kernel-doc warnings

[Randy Dunlap]

kernel-doc does not support DECLARE_PER_CPU(), so don't mark it with
kernel-doc notation.

One comment block is not kernel-doc notation, so just use
"/*" to begin the comment.

Quietens these warnings:

netfilter.h:493: warning: Function parameter or member 'bool' not described in 'DECLARE_PER_CPU'
netfilter.h:493: warning: Function parameter or member 'nf_skb_duplicated' not described in 'DECLARE_PER_CPU'
netfilter.h:493: warning: expecting prototype for nf_skb_duplicated(). Prototype was for DECLARE_PER_CPU() instead
netfilter.h:496: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Contains bitmask of ctnetlink event subscribers, if any.

Fixes: e7c8899f3e6f ("netfilter: move tee_active to core")
Fixes: fdf6491193e4 ("netfilter: ctnetlink: make event listener tracking global")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Florian Westphal <fw@strlen.de>
Cc: Pablo Neira Ayuso <pablo@netfilter.org>
Cc: Jozsef Kadlecsik <kadlec@netfilter.org>
Cc: netfilter-devel@vger.kernel.org
Cc: coreteam@netfilter.org
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
---
 include/linux/netfilter.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/include/linux/netfilter.h b/include/linux/netfilter.h
--- a/include/linux/netfilter.h
+++ b/include/linux/netfilter.h
@@ -481,7 +481,7 @@ struct nfnl_ct_hook {
 };
 extern const struct nfnl_ct_hook __rcu *nfnl_ct_hook;
 
-/**
+/*
  * nf_skb_duplicated - TEE target has sent a packet
  *
  * When a xtables target sends a packet, the OUTPUT and POSTROUTING
@@ -492,7 +492,7 @@ extern const struct nfnl_ct_hook __rcu *
  */
 DECLARE_PER_CPU(bool, nf_skb_duplicated);
 
-/**
+/*
  * Contains bitmask of ctnetlink event subscribers, if any.
  * Can't be pernet due to NETLINK_LISTEN_ALL_NSID setsockopt flag.
  */

Re: [PATCH net-next] linux/netfilter.h: fix kernel-doc warnings

[Simon Horman]

On Thu, Jun 22, 2023 at 11:11:01PM -0700, Randy Dunlap wrote:
> kernel-doc does not support DECLARE_PER_CPU(), so don't mark it with
> kernel-doc notation.
> 
> One comment block is not kernel-doc notation, so just use
> "/*" to begin the comment.
> 
> Quietens these warnings:
> 
> netfilter.h:493: warning: Function parameter or member 'bool' not described in 'DECLARE_PER_CPU'
> netfilter.h:493: warning: Function parameter or member 'nf_skb_duplicated' not described in 'DECLARE_PER_CPU'
> netfilter.h:493: warning: expecting prototype for nf_skb_duplicated(). Prototype was for DECLARE_PER_CPU() instead
> netfilter.h:496: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Contains bitmask of ctnetlink event subscribers, if any.
> 
> Fixes: e7c8899f3e6f ("netfilter: move tee_active to core")
> Fixes: fdf6491193e4 ("netfilter: ctnetlink: make event listener tracking global")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Florian Westphal <fw@strlen.de>
> Cc: Pablo Neira Ayuso <pablo@netfilter.org>
> Cc: Jozsef Kadlecsik <kadlec@netfilter.org>
> Cc: netfilter-devel@vger.kernel.org
> Cc: coreteam@netfilter.org
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Eric Dumazet <edumazet@google.com>
> Cc: Jakub Kicinski <kuba@kernel.org>
> Cc: Paolo Abeni <pabeni@redhat.com>

Reviewed-by: Simon Horman <simon.horman@corigine.com>

Re: [PATCH net-next] linux/netfilter.h: fix kernel-doc warnings

[Pablo Neira Ayuso]

On Thu, Jun 22, 2023 at 11:11:01PM -0700, Randy Dunlap wrote:
> kernel-doc does not support DECLARE_PER_CPU(), so don't mark it with
> kernel-doc notation.
> 
> One comment block is not kernel-doc notation, so just use
> "/*" to begin the comment.
> 
> Quietens these warnings:
> 
> netfilter.h:493: warning: Function parameter or member 'bool' not described in 'DECLARE_PER_CPU'
> netfilter.h:493: warning: Function parameter or member 'nf_skb_duplicated' not described in 'DECLARE_PER_CPU'
> netfilter.h:493: warning: expecting prototype for nf_skb_duplicated(). Prototype was for DECLARE_PER_CPU() instead
> netfilter.h:496: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Contains bitmask of ctnetlink event subscribers, if any.

Applied to nf.git, thanks