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

Configure Feed

Select the types of activity you want to include in your feed.

flow_dissector: Address kdoc warnings

Address a number of warnings flagged by
./scripts/kernel-doc -none include/net/flow_dissector.h

include/net/flow_dissector.h:23: warning: Function parameter or member 'addr_type' not described in 'flow_dissector_key_control'
include/net/flow_dissector.h:23: warning: Function parameter or member 'flags' not described in 'flow_dissector_key_control'
include/net/flow_dissector.h:46: warning: Function parameter or member 'padding' not described in 'flow_dissector_key_basic'
include/net/flow_dissector.h:145: warning: Function parameter or member 'tipckey' not described in 'flow_dissector_key_addrs'
include/net/flow_dissector.h:157: warning: cannot understand function prototype: 'struct flow_dissector_key_arp '
include/net/flow_dissector.h:171: warning: cannot understand function prototype: 'struct flow_dissector_key_ports '
include/net/flow_dissector.h:203: warning: cannot understand function prototype: 'struct flow_dissector_key_icmp '

Also improve indentation on adjacent lines to those changed
to address the above.

No functional changes intended.

Signed-off-by: Simon Horman <horms@kernel.org>
Link: https://lore.kernel.org/r/20230419-flow-dissector-kdoc-v1-1-1aa0cca1118b@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Simon Horman and committed by
Jakub Kicinski 8c966a10 dd64b232

+20 -18
+20 -18
include/net/flow_dissector.h
··· 14 14 15 15 /** 16 16 * struct flow_dissector_key_control: 17 - * @thoff: Transport header offset 17 + * @thoff: Transport header offset 18 + * @addr_type: Type of key. One of FLOW_DISSECTOR_KEY_* 19 + * @flags: Key flags. Any of FLOW_DIS_(IS_FRAGMENT|FIRST_FRAGENCAPSULATION) 18 20 */ 19 21 struct flow_dissector_key_control { 20 22 u16 thoff; ··· 38 36 39 37 /** 40 38 * struct flow_dissector_key_basic: 41 - * @n_proto: Network header protocol (eg. IPv4/IPv6) 39 + * @n_proto: Network header protocol (eg. IPv4/IPv6) 42 40 * @ip_proto: Transport header protocol (eg. TCP/UDP) 41 + * @padding: Unused 43 42 */ 44 43 struct flow_dissector_key_basic { 45 44 __be16 n_proto; ··· 138 135 * struct flow_dissector_key_addrs: 139 136 * @v4addrs: IPv4 addresses 140 137 * @v6addrs: IPv6 addresses 138 + * @tipckey: TIPC key 141 139 */ 142 140 struct flow_dissector_key_addrs { 143 141 union { ··· 149 145 }; 150 146 151 147 /** 152 - * flow_dissector_key_arp: 153 - * @ports: Operation, source and target addresses for an ARP header 154 - * for Ethernet hardware addresses and IPv4 protocol addresses 155 - * sip: Sender IP address 156 - * tip: Target IP address 157 - * op: Operation 158 - * sha: Sender hardware address 159 - * tpa: Target hardware address 148 + * struct flow_dissector_key_arp: 149 + * @sip: Sender IP address 150 + * @tip: Target IP address 151 + * @op: Operation 152 + * @sha: Sender hardware address 153 + * @tha: Target hardware address 160 154 */ 161 155 struct flow_dissector_key_arp { 162 156 __u32 sip; ··· 165 163 }; 166 164 167 165 /** 168 - * flow_dissector_key_tp_ports: 169 - * @ports: port numbers of Transport header 170 - * src: source port number 171 - * dst: destination port number 166 + * struct flow_dissector_key_ports: 167 + * @ports: port numbers of Transport header 168 + * @src: source port number 169 + * @dst: destination port number 172 170 */ 173 171 struct flow_dissector_key_ports { 174 172 union { ··· 197 195 }; 198 196 199 197 /** 200 - * flow_dissector_key_icmp: 201 - * type: ICMP type 202 - * code: ICMP code 203 - * id: session identifier 198 + * struct flow_dissector_key_icmp: 199 + * @type: ICMP type 200 + * @code: ICMP code 201 + * @id: Session identifier 204 202 */ 205 203 struct flow_dissector_key_icmp { 206 204 struct {