korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 12:28:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

flow_dissector: Address kdoc warnings

Browse Source 
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>
This commit is contained in:
Simon Horman 2023-04-19 13:34:35 +02:00 committed by Jakub Kicinski
parent dd64b232de
commit 8c966a10eb
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
include/net/flow_dissector.h
View File

@ -14,7 +14,9 @@ struct sk_buff;
/**
* struct flow_dissector_key_control:
* @thoff: Transport header offset
* @thoff: Transport header offset
* @addr_type: Type of key. One of FLOW_DISSECTOR_KEY_*
* @flags: Key flags. Any of FLOW_DIS_(IS_FRAGMENT|FIRST_FRAGENCAPSULATION)
*/
struct flow_dissector_key_control {
u16 thoff;
@ -36,8 +38,9 @@ enum flow_dissect_ret {
/**
* struct flow_dissector_key_basic:
* @n_proto: Network header protocol (eg. IPv4/IPv6)
* @n_proto: Network header protocol (eg. IPv4/IPv6)
* @ip_proto: Transport header protocol (eg. TCP/UDP)
* @padding: Unused
*/
struct flow_dissector_key_basic {
__be16 n_proto;
@ -135,6 +138,7 @@ struct flow_dissector_key_tipc {
* struct flow_dissector_key_addrs:
* @v4addrs: IPv4 addresses
* @v6addrs: IPv6 addresses
* @tipckey: TIPC key
*/
struct flow_dissector_key_addrs {
union {
@ -145,14 +149,12 @@ struct flow_dissector_key_addrs {
};
/**
* flow_dissector_key_arp:
* @ports: Operation, source and target addresses for an ARP header
* for Ethernet hardware addresses and IPv4 protocol addresses
* sip: Sender IP address
* tip: Target IP address
* op: Operation
* sha: Sender hardware address
* tpa: Target hardware address
* struct flow_dissector_key_arp:
* @sip: Sender IP address
* @tip: Target IP address
* @op: Operation
* @sha: Sender hardware address
* @tha: Target hardware address
*/
struct flow_dissector_key_arp {
__u32 sip;
@ -163,10 +165,10 @@ struct flow_dissector_key_arp {
};
/**
* flow_dissector_key_tp_ports:
* @ports: port numbers of Transport header
* src: source port number
* dst: destination port number
* struct flow_dissector_key_ports:
* @ports: port numbers of Transport header
* @src: source port number
* @dst: destination port number
*/
struct flow_dissector_key_ports {
union {
@ -195,10 +197,10 @@ struct flow_dissector_key_ports_range {
};
/**
* flow_dissector_key_icmp:
* type: ICMP type
* code: ICMP code
* id: session identifier
* struct flow_dissector_key_icmp:
* @type: ICMP type
* @code: ICMP code
* @id: Session identifier
*/
struct flow_dissector_key_icmp {
struct {