Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Randy Dunlap and committed by
Pablo Neira Ayuso
d3a439e5 c4f0ab06

+7 -7
+7 -7
include/uapi/linux/netfilter/nf_tables.h
··· 881 881 * enum nft_exthdr_op - nf_tables match options 882 882 * 883 883 * @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 885 885 * @NFT_EXTHDR_OP_IPV4: match against ipv4 options 886 886 * @NFT_EXTHDR_OP_SCTP: match against sctp chunks 887 887 * @NFT_EXTHDR_OP_DCCP: match against dccp otions ··· 1200 1200 #define NFTA_CT_MAX (__NFTA_CT_MAX - 1) 1201 1201 1202 1202 /** 1203 - * enum nft_flow_attributes - ct offload expression attributes 1203 + * enum nft_offload_attributes - ct offload expression attributes 1204 1204 * @NFTA_FLOW_TABLE_NAME: flow table name (NLA_STRING) 1205 1205 */ 1206 1206 enum nft_offload_attributes { ··· 1410 1410 }; 1411 1411 1412 1412 /** 1413 - * enum nft_reject_code - Generic reject codes for IPv4/IPv6 1413 + * enum nft_reject_inet_code - Generic reject codes for IPv4/IPv6 1414 1414 * 1415 1415 * @NFT_REJECT_ICMPX_NO_ROUTE: no route to host / network unreachable 1416 1416 * @NFT_REJECT_ICMPX_PORT_UNREACH: port unreachable ··· 1480 1480 /** 1481 1481 * enum nft_tproxy_attributes - nf_tables tproxy expression netlink attributes 1482 1482 * 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) 1486 1486 */ 1487 1487 enum nft_tproxy_attributes { 1488 1488 NFTA_TPROXY_UNSPEC, ··· 1783 1783 #define NFTA_SYNPROXY_MAX (__NFTA_SYNPROXY_MAX - 1) 1784 1784 1785 1785 /** 1786 - * enum nft_device_attributes - nf_tables device netlink attributes 1786 + * enum nft_devices_attributes - nf_tables device netlink attributes 1787 1787 * 1788 1788 * @NFTA_DEVICE_NAME: name of this device (NLA_STRING) 1789 1789 * @NFTA_DEVICE_PREFIX: device name prefix, a simple wildcard (NLA_STRING)