GitHub-Mirror/Star64_linux
2
0
Fork 0
mirror of https://github.com/Fishwaldo/Star64_linux.git synced 2025-07-10 00:26:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

batman-adv: Use parentheses in function kernel-doc

Browse source 
The documentation describing kernel-doc comments for functions ("How to
format kernel-doc comments") uses parentheses at the end of the function
name. Using this format allows to use a consistent style when adding
documentation to a function and when referencing this function in a
different kernel-doc section.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
This commit is contained in:
Sven Eckelmann 2017-12-02 19:51:47 +01:00 • committed by Simon Wunderlich
parent 6a3038f07c
commit 7e9a8c2ce7
34 changed files with 633 additions and 619 deletions
Download patch file Download diff file Expand all files Collapse all files

77
net/batman-adv/distributed-arp-table.c
View file

@ -56,7 +56,7 @@
static void batadv_dat_purge(struct work_struct *work);
/**
* batadv_dat_start_timer - initialise the DAT periodic worker
* batadv_dat_start_timer() - initialise the DAT periodic worker
* @bat_priv: the bat priv with all the soft interface information
*/
static void batadv_dat_start_timer(struct batadv_priv *bat_priv)
@ -67,7 +67,7 @@ static void batadv_dat_start_timer(struct batadv_priv *bat_priv)
}
/**
* batadv_dat_entry_release - release dat_entry from lists and queue for free
* batadv_dat_entry_release() - release dat_entry from lists and queue for free
* after rcu grace period
* @ref: kref pointer of the dat_entry
*/
@ -81,7 +81,7 @@ static void batadv_dat_entry_release(struct kref *ref)
}
/**
* batadv_dat_entry_put - decrement the dat_entry refcounter and possibly
* batadv_dat_entry_put() - decrement the dat_entry refcounter and possibly
* release it
* @dat_entry: dat_entry to be free'd
*/
@ -91,7 +91,7 @@ static void batadv_dat_entry_put(struct batadv_dat_entry *dat_entry)
}
/**
* batadv_dat_to_purge - check whether a dat_entry has to be purged or not
* batadv_dat_to_purge() - check whether a dat_entry has to be purged or not
* @dat_entry: the entry to check
*
* Return: true if the entry has to be purged now, false otherwise.
@ -103,7 +103,7 @@ static bool batadv_dat_to_purge(struct batadv_dat_entry *dat_entry)
}
/**
* __batadv_dat_purge - delete entries from the DAT local storage
* __batadv_dat_purge() - delete entries from the DAT local storage
* @bat_priv: the bat priv with all the soft interface information
* @to_purge: function in charge to decide whether an entry has to be purged or
* not. This function takes the dat_entry as argument and has to
@ -146,8 +146,8 @@ static void __batadv_dat_purge(struct batadv_priv *bat_priv,
}
/**
* batadv_dat_purge - periodic task that deletes old entries from the local DAT
* hash table
* batadv_dat_purge() - periodic task that deletes old entries from the local
* DAT hash table
* @work: kernel work struct
*/
static void batadv_dat_purge(struct work_struct *work)
@ -165,7 +165,7 @@ static void batadv_dat_purge(struct work_struct *work)
}
/**
* batadv_compare_dat - comparing function used in the local DAT hash table
* batadv_compare_dat() - comparing function used in the local DAT hash table
* @node: node in the local table
* @data2: second object to compare the node to
*
@ -180,7 +180,7 @@ static bool batadv_compare_dat(const struct hlist_node *node, const void *data2)
}
/**
* batadv_arp_hw_src - extract the hw_src field from an ARP packet
* batadv_arp_hw_src() - extract the hw_src field from an ARP packet
* @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet
*
@ -197,7 +197,7 @@ static u8 *batadv_arp_hw_src(struct sk_buff *skb, int hdr_size)
}
/**
* batadv_arp_ip_src - extract the ip_src field from an ARP packet
* batadv_arp_ip_src() - extract the ip_src field from an ARP packet
* @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet
*
@ -209,7 +209,7 @@ static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
}
/**
* batadv_arp_hw_dst - extract the hw_dst field from an ARP packet
* batadv_arp_hw_dst() - extract the hw_dst field from an ARP packet
* @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet
*
@ -221,7 +221,7 @@ static u8 *batadv_arp_hw_dst(struct sk_buff *skb, int hdr_size)
}
/**
* batadv_arp_ip_dst - extract the ip_dst field from an ARP packet
* batadv_arp_ip_dst() - extract the ip_dst field from an ARP packet
* @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet
*
@ -233,7 +233,7 @@ static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
}
/**
* batadv_hash_dat - compute the hash value for an IP address
* batadv_hash_dat() - compute the hash value for an IP address
* @data: data to hash
* @size: size of the hash table
*
@ -268,7 +268,7 @@ static u32 batadv_hash_dat(const void *data, u32 size)
}
/**
* batadv_dat_entry_hash_find - look for a given dat_entry in the local hash
* batadv_dat_entry_hash_find() - look for a given dat_entry in the local hash
* table
* @bat_priv: the bat priv with all the soft interface information
* @ip: search key
@ -311,7 +311,7 @@ batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip,
}
/**
* batadv_dat_entry_add - add a new dat entry or update it if already exists
* batadv_dat_entry_add() - add a new dat entry or update it if already exists
* @bat_priv: the bat priv with all the soft interface information
* @ip: ipv4 to add/edit
* @mac_addr: mac address to assign to the given ipv4
@ -368,7 +368,8 @@ out:
#ifdef CONFIG_BATMAN_ADV_DEBUG
/**
* batadv_dbg_arp - print a debug message containing all the ARP packet details
* batadv_dbg_arp() - print a debug message containing all the ARP packet
* details
* @bat_priv: the bat priv with all the soft interface information
* @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet
@ -449,7 +450,7 @@ static void batadv_dbg_arp(struct batadv_priv *bat_priv, struct sk_buff *skb,
#endif /* CONFIG_BATMAN_ADV_DEBUG */
/**
* batadv_is_orig_node_eligible - check whether a node can be a DHT candidate
* batadv_is_orig_node_eligible() - check whether a node can be a DHT candidate
* @res: the array with the already selected candidates
* @select: number of already selected candidates
* @tmp_max: address of the currently evaluated node
@ -503,7 +504,7 @@ out:
}
/**
* batadv_choose_next_candidate - select the next DHT candidate
* batadv_choose_next_candidate() - select the next DHT candidate
* @bat_priv: the bat priv with all the soft interface information
* @cands: candidates array
* @select: number of candidates already present in the array
@ -567,8 +568,8 @@ static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,
}
/**
* batadv_dat_select_candidates - select the nodes which the DHT message has to
* be sent to
* batadv_dat_select_candidates() - select the nodes which the DHT message has
* to be sent to
* @bat_priv: the bat priv with all the soft interface information
* @ip_dst: ipv4 to look up in the DHT
* @vid: VLAN identifier
@ -613,7 +614,7 @@ batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst,
}
/**
* batadv_dat_send_data - send a payload to the selected candidates
* batadv_dat_send_data() - send a payload to the selected candidates
* @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send
* @ip: the DHT key
@ -689,7 +690,7 @@ out:
}
/**
* batadv_dat_tvlv_container_update - update the dat tvlv container after dat
* batadv_dat_tvlv_container_update() - update the dat tvlv container after dat
* setting change
* @bat_priv: the bat priv with all the soft interface information
*/
@ -711,7 +712,7 @@ static void batadv_dat_tvlv_container_update(struct batadv_priv *bat_priv)
}
/**
* batadv_dat_status_update - update the dat tvlv container after dat
* batadv_dat_status_update() - update the dat tvlv container after dat
* setting change
* @net_dev: the soft interface net device
*/
@ -723,7 +724,7 @@ void batadv_dat_status_update(struct net_device *net_dev)
}
/**
* batadv_dat_tvlv_ogm_handler_v1 - process incoming dat tvlv container
* batadv_dat_tvlv_ogm_handler_v1() - process incoming dat tvlv container
* @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -742,7 +743,7 @@ static void batadv_dat_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
}
/**
* batadv_dat_hash_free - free the local DAT hash table
* batadv_dat_hash_free() - free the local DAT hash table
* @bat_priv: the bat priv with all the soft interface information
*/
static void batadv_dat_hash_free(struct batadv_priv *bat_priv)
@ -758,7 +759,7 @@ static void batadv_dat_hash_free(struct batadv_priv *bat_priv)
}
/**
* batadv_dat_init - initialise the DAT internals
* batadv_dat_init() - initialise the DAT internals
* @bat_priv: the bat priv with all the soft interface information
*
* Return: 0 in case of success, a negative error code otherwise
@ -783,7 +784,7 @@ int batadv_dat_init(struct batadv_priv *bat_priv)
}
/**
* batadv_dat_free - free the DAT internals
* batadv_dat_free() - free the DAT internals
* @bat_priv: the bat priv with all the soft interface information
*/
void batadv_dat_free(struct batadv_priv *bat_priv)
@ -798,7 +799,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS
/**
* batadv_dat_cache_seq_print_text - print the local DAT hash table
* batadv_dat_cache_seq_print_text() - print the local DAT hash table
* @seq: seq file to print on
* @offset: not used
*
@ -851,7 +852,7 @@ out:
#endif
/**
* batadv_arp_get_type - parse an ARP packet and gets the type
* batadv_arp_get_type() - parse an ARP packet and gets the type
* @bat_priv: the bat priv with all the soft interface information
* @skb: packet to analyse
* @hdr_size: size of the possible header before the ARP packet in the skb
@ -925,7 +926,7 @@ out:
}
/**
* batadv_dat_get_vid - extract the VLAN identifier from skb if any
* batadv_dat_get_vid() - extract the VLAN identifier from skb if any
* @skb: the buffer containing the packet to extract the VID from
* @hdr_size: the size of the batman-adv header encapsulating the packet
*
@ -951,7 +952,7 @@ static unsigned short batadv_dat_get_vid(struct sk_buff *skb, int *hdr_size)
}
/**
* batadv_dat_arp_create_reply - create an ARP Reply
* batadv_dat_arp_create_reply() - create an ARP Reply
* @bat_priv: the bat priv with all the soft interface information
* @ip_src: ARP sender IP
* @ip_dst: ARP target IP
@ -986,7 +987,7 @@ batadv_dat_arp_create_reply(struct batadv_priv *bat_priv, __be32 ip_src,
}
/**
* batadv_dat_snoop_outgoing_arp_request - snoop the ARP request and try to
* batadv_dat_snoop_outgoing_arp_request() - snoop the ARP request and try to
* answer using DAT
* @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check
@ -1084,7 +1085,7 @@ out:
}
/**
* batadv_dat_snoop_incoming_arp_request - snoop the ARP request and try to
* batadv_dat_snoop_incoming_arp_request() - snoop the ARP request and try to
* answer using the local DAT storage
* @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check
@ -1154,7 +1155,7 @@ out:
}
/**
* batadv_dat_snoop_outgoing_arp_reply - snoop the ARP reply and fill the DHT
* batadv_dat_snoop_outgoing_arp_reply() - snoop the ARP reply and fill the DHT
* @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check
*/
@ -1194,8 +1195,8 @@ void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,
}
/**
* batadv_dat_snoop_incoming_arp_reply - snoop the ARP reply and fill the local
* DAT storage only
* batadv_dat_snoop_incoming_arp_reply() - snoop the ARP reply and fill the
* local DAT storage only
* @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check
* @hdr_size: size of the encapsulation header
@ -1283,8 +1284,8 @@ out:
}
/**
* batadv_dat_drop_broadcast_packet - check if an ARP request has to be dropped
* (because the node has already obtained the reply via DAT) or not
* batadv_dat_drop_broadcast_packet() - check if an ARP request has to be
* dropped (because the node has already obtained the reply via DAT) or not
* @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the broadcast packet
*