superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

netfilter: nf_tables: improve UAPI kernel-doc comments 

In include/uapi/linux/netfilter/nf_tables.h,
correct the kernel-doc comments for mistyped enum names and enum values to
avoid these kernel-doc warnings and improve the documentation:

nf_tables.h:896: warning: Enum value 'NFT_EXTHDR_OP_TCPOPT' not described
 in enum 'nft_exthdr_op'
nf_tables.h:896: warning: Excess enum value 'NFT_EXTHDR_OP_TCP' description
 in 'nft_exthdr_op'

nf_tables.h:1210: warning: expecting prototype for enum
 nft_flow_attributes. Prototype was for enum nft_offload_attributes instead

nf_tables.h:1428: warning: expecting prototype for enum nft_reject_code.
 Prototype was for enum nft_reject_inet_code instead

(add beginning '@' to each enum value description:)
nf_tables.h:1493: warning: Enum value 'NFTA_TPROXY_FAMILY' not described
 in enum 'nft_tproxy_attributes'
nf_tables.h:1493: warning: Enum value 'NFTA_TPROXY_REG_ADDR' not described
 in enum 'nft_tproxy_attributes'
nf_tables.h:1493: warning: Enum value 'NFTA_TPROXY_REG_PORT' not described
 in enum 'nft_tproxy_attributes'

nf_tables.h:1796: warning: expecting prototype for enum
 nft_device_attributes. Prototype was for enum
 nft_devices_attributes instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Florian Westphal <fw@strlen.de>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
pull/1354/merge
Randy Dunlap 2025-11-01 12:20:38 -07:00 committed by Pablo Neira Ayuso
parent c4f0ab06e1
commit d3a439e55c
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/uapi/linux/netfilter/nf_tables.h
View File

@ -881,7 +881,7 @@ enum nft_exthdr_flags {
* enum nft_exthdr_op - nf_tables match options * enum nft_exthdr_op - nf_tables match options
* *
* @NFT_EXTHDR_OP_IPV6: match against ipv6 extension headers * @NFT_EXTHDR_OP_IPV6: match against ipv6 extension headers
* @NFT_EXTHDR_OP_TCP: match against tcp options * @NFT_EXTHDR_OP_TCPOPT: match against tcp options
* @NFT_EXTHDR_OP_IPV4: match against ipv4 options * @NFT_EXTHDR_OP_IPV4: match against ipv4 options
* @NFT_EXTHDR_OP_SCTP: match against sctp chunks * @NFT_EXTHDR_OP_SCTP: match against sctp chunks
* @NFT_EXTHDR_OP_DCCP: match against dccp otions * @NFT_EXTHDR_OP_DCCP: match against dccp otions
@ -1200,7 +1200,7 @@ enum nft_ct_attributes {
#define NFTA_CT_MAX (__NFTA_CT_MAX - 1) #define NFTA_CT_MAX (__NFTA_CT_MAX - 1)
/** /**
* enum nft_flow_attributes - ct offload expression attributes * enum nft_offload_attributes - ct offload expression attributes
* @NFTA_FLOW_TABLE_NAME: flow table name (NLA_STRING) * @NFTA_FLOW_TABLE_NAME: flow table name (NLA_STRING)
*/ */
enum nft_offload_attributes { enum nft_offload_attributes {
@ -1410,7 +1410,7 @@ enum nft_reject_types {
}; };
/** /**
* enum nft_reject_code - Generic reject codes for IPv4/IPv6 * enum nft_reject_inet_code - Generic reject codes for IPv4/IPv6
* *
* @NFT_REJECT_ICMPX_NO_ROUTE: no route to host / network unreachable * @NFT_REJECT_ICMPX_NO_ROUTE: no route to host / network unreachable
* @NFT_REJECT_ICMPX_PORT_UNREACH: port unreachable * @NFT_REJECT_ICMPX_PORT_UNREACH: port unreachable
@ -1480,9 +1480,9 @@ enum nft_nat_attributes {
/** /**
* enum nft_tproxy_attributes - nf_tables tproxy expression netlink attributes * enum nft_tproxy_attributes - nf_tables tproxy expression netlink attributes
* *
* NFTA_TPROXY_FAMILY: Target address family (NLA_U32: nft_registers) * @NFTA_TPROXY_FAMILY: Target address family (NLA_U32: nft_registers)
* NFTA_TPROXY_REG_ADDR: Target address register (NLA_U32: nft_registers) * @NFTA_TPROXY_REG_ADDR: Target address register (NLA_U32: nft_registers)
* NFTA_TPROXY_REG_PORT: Target port register (NLA_U32: nft_registers) * @NFTA_TPROXY_REG_PORT: Target port register (NLA_U32: nft_registers)
*/ */
enum nft_tproxy_attributes { enum nft_tproxy_attributes {
NFTA_TPROXY_UNSPEC, NFTA_TPROXY_UNSPEC,
@ -1783,7 +1783,7 @@ enum nft_synproxy_attributes {
#define NFTA_SYNPROXY_MAX (__NFTA_SYNPROXY_MAX - 1) #define NFTA_SYNPROXY_MAX (__NFTA_SYNPROXY_MAX - 1)
/** /**
* enum nft_device_attributes - nf_tables device netlink attributes * enum nft_devices_attributes - nf_tables device netlink attributes
* *
* @NFTA_DEVICE_NAME: name of this device (NLA_STRING) * @NFTA_DEVICE_NAME: name of this device (NLA_STRING)
* @NFTA_DEVICE_PREFIX: device name prefix, a simple wildcard (NLA_STRING) * @NFTA_DEVICE_PREFIX: device name prefix, a simple wildcard (NLA_STRING)