Skip to content

Commit 8c966a1

Browse files
hormskuba-moo
authored andcommitted
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>
1 parent dd64b23 commit 8c966a1

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

include/net/flow_dissector.h

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ struct sk_buff;
1414

1515
/**
1616
* 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)
1820
*/
1921
struct flow_dissector_key_control {
2022
u16 thoff;
@@ -36,8 +38,9 @@ enum flow_dissect_ret {
3638

3739
/**
3840
* struct flow_dissector_key_basic:
39-
* @n_proto: Network header protocol (eg. IPv4/IPv6)
41+
* @n_proto: Network header protocol (eg. IPv4/IPv6)
4042
* @ip_proto: Transport header protocol (eg. TCP/UDP)
43+
* @padding: Unused
4144
*/
4245
struct flow_dissector_key_basic {
4346
__be16 n_proto;
@@ -135,6 +138,7 @@ struct flow_dissector_key_tipc {
135138
* struct flow_dissector_key_addrs:
136139
* @v4addrs: IPv4 addresses
137140
* @v6addrs: IPv6 addresses
141+
* @tipckey: TIPC key
138142
*/
139143
struct flow_dissector_key_addrs {
140144
union {
@@ -145,14 +149,12 @@ struct flow_dissector_key_addrs {
145149
};
146150

147151
/**
148-
* flow_dissector_key_arp:
149-
* @ports: Operation, source and target addresses for an ARP header
150-
* for Ethernet hardware addresses and IPv4 protocol addresses
151-
* sip: Sender IP address
152-
* tip: Target IP address
153-
* op: Operation
154-
* sha: Sender hardware address
155-
* tpa: Target hardware address
152+
* struct flow_dissector_key_arp:
153+
* @sip: Sender IP address
154+
* @tip: Target IP address
155+
* @op: Operation
156+
* @sha: Sender hardware address
157+
* @tha: Target hardware address
156158
*/
157159
struct flow_dissector_key_arp {
158160
__u32 sip;
@@ -163,10 +165,10 @@ struct flow_dissector_key_arp {
163165
};
164166

165167
/**
166-
* flow_dissector_key_tp_ports:
167-
* @ports: port numbers of Transport header
168-
* src: source port number
169-
* dst: destination port number
168+
* struct flow_dissector_key_ports:
169+
* @ports: port numbers of Transport header
170+
* @src: source port number
171+
* @dst: destination port number
170172
*/
171173
struct flow_dissector_key_ports {
172174
union {
@@ -195,10 +197,10 @@ struct flow_dissector_key_ports_range {
195197
};
196198

197199
/**
198-
* flow_dissector_key_icmp:
199-
* type: ICMP type
200-
* code: ICMP code
201-
* id: session identifier
200+
* struct flow_dissector_key_icmp:
201+
* @type: ICMP type
202+
* @code: ICMP code
203+
* @id: Session identifier
202204
*/
203205
struct flow_dissector_key_icmp {
204206
struct {

0 commit comments

Comments
 (0)