Skip to content

Commit d3a439e

Browse files
rddunlapummakynes
authored andcommitted
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>
1 parent c4f0ab0 commit d3a439e

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

include/uapi/linux/netfilter/nf_tables.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -881,7 +881,7 @@ enum nft_exthdr_flags {
881881
* enum nft_exthdr_op - nf_tables match options
882882
*
883883
* @NFT_EXTHDR_OP_IPV6: match against ipv6 extension headers
884-
* @NFT_EXTHDR_OP_TCP: match against tcp options
884+
* @NFT_EXTHDR_OP_TCPOPT: match against tcp options
885885
* @NFT_EXTHDR_OP_IPV4: match against ipv4 options
886886
* @NFT_EXTHDR_OP_SCTP: match against sctp chunks
887887
* @NFT_EXTHDR_OP_DCCP: match against dccp otions
@@ -1200,7 +1200,7 @@ enum nft_ct_attributes {
12001200
#define NFTA_CT_MAX (__NFTA_CT_MAX - 1)
12011201

12021202
/**
1203-
* enum nft_flow_attributes - ct offload expression attributes
1203+
* enum nft_offload_attributes - ct offload expression attributes
12041204
* @NFTA_FLOW_TABLE_NAME: flow table name (NLA_STRING)
12051205
*/
12061206
enum nft_offload_attributes {
@@ -1410,7 +1410,7 @@ enum nft_reject_types {
14101410
};
14111411

14121412
/**
1413-
* enum nft_reject_code - Generic reject codes for IPv4/IPv6
1413+
* enum nft_reject_inet_code - Generic reject codes for IPv4/IPv6
14141414
*
14151415
* @NFT_REJECT_ICMPX_NO_ROUTE: no route to host / network unreachable
14161416
* @NFT_REJECT_ICMPX_PORT_UNREACH: port unreachable
@@ -1480,9 +1480,9 @@ enum nft_nat_attributes {
14801480
/**
14811481
* enum nft_tproxy_attributes - nf_tables tproxy expression netlink attributes
14821482
*
1483-
* NFTA_TPROXY_FAMILY: Target address family (NLA_U32: nft_registers)
1484-
* NFTA_TPROXY_REG_ADDR: Target address register (NLA_U32: nft_registers)
1485-
* NFTA_TPROXY_REG_PORT: Target port register (NLA_U32: nft_registers)
1483+
* @NFTA_TPROXY_FAMILY: Target address family (NLA_U32: nft_registers)
1484+
* @NFTA_TPROXY_REG_ADDR: Target address register (NLA_U32: nft_registers)
1485+
* @NFTA_TPROXY_REG_PORT: Target port register (NLA_U32: nft_registers)
14861486
*/
14871487
enum nft_tproxy_attributes {
14881488
NFTA_TPROXY_UNSPEC,
@@ -1783,7 +1783,7 @@ enum nft_synproxy_attributes {
17831783
#define NFTA_SYNPROXY_MAX (__NFTA_SYNPROXY_MAX - 1)
17841784

17851785
/**
1786-
* enum nft_device_attributes - nf_tables device netlink attributes
1786+
* enum nft_devices_attributes - nf_tables device netlink attributes
17871787
*
17881788
* @NFTA_DEVICE_NAME: name of this device (NLA_STRING)
17891789
* @NFTA_DEVICE_PREFIX: device name prefix, a simple wildcard (NLA_STRING)

0 commit comments

Comments
 (0)