kerneldoc cleanups
Sven Eckelmann
maintainerHi,
just some minor kerneldoc cleanups of things I found while running
(./scripts/kernel-doc -v -list net/batman-adv/*.{c,h} 2>&1 > /dev/null)| \
grep -v Scanning|grep -v -e BATADV_TQ_LOCAL_WINDOW_SIZE \
-e "Excess struct/union/enum/typedef member 'bcast_bits' description in 'batadv_orig_node'" \
-e "Excess struct/union/enum/typedef member 'real_bits' description in 'batadv_neigh_ifinfo_bat_iv'" \
-e '#ifdef' -e "#define" -e '#endif' \
-e "[0-9]* warnings" \
-e 'no structured comments found'There are still some warnings left.
Kind regards,
Sven
Sven Eckelmann
maintainerPATCH 1/9 batman-adv: Fix kernel-doc parsing of main structs
kernel-doc is not able to skip an #ifdef between the kernel documentation block and the start of the struct. Moving the #ifdef before the kernel doc block avoids this problem
--- net/batman-adv/types.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-)
net/batman-adv/types.h +10 -5
@@ -401,13 +401,14 @@ struct batadv_neigh_ifinfo {struct rcu_head rcu; }; +#ifdef CONFIG_BATMAN_ADV_BLA + /** * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast * @crc: crc32 checksum of broadcast payload * @entrytime: time when the broadcast packet was received */ -#ifdef CONFIG_BATMAN_ADV_BLA struct batadv_bcast_duplist_entry { u8 orig[ETH_ALEN]; __be32 crc;
@@ -549,6 +550,8 @@ struct batadv_priv_tt {struct delayed_work work; }; +#ifdef CONFIG_BATMAN_ADV_BLA +/** * struct batadv_priv_bla - per mesh interface bridge loope avoidance data * @num_requests; number of bla requests in flight
@@ -561,7 +564,6 @@ struct batadv_priv_tt {* @claim_dest: local claim data (e.g. claim group) * @work: work queue callback item for cleanups & bla announcements */ -#ifdef CONFIG_BATMAN_ADV_BLAstruct batadv_priv_bla {atomic_t num_requests;struct batadv_hashtable *claim_hash;
@@ -575,6 +577,8 @@ struct batadv_priv_bla { };#endif +#ifdef CONFIG_BATMAN_ADV_DEBUG +/** * struct batadv_priv_debug_log - debug logging data * @log_buff: buffer holding the logs (ring bufer)
@@ -583,7 +587,6 @@ struct batadv_priv_bla {* @lock: lock protecting log_buff, log_start & log_end * @queue_wait: log reader's wait queue */ -#ifdef CONFIG_BATMAN_ADV_DEBUGstruct batadv_priv_debug_log {char log_buff[BATADV_LOG_BUF_LEN ];unsigned long log_start;
@@ -625,13 +628,14 @@ struct batadv_priv_tvlv {spinlock_t handler_list_lock;/* protects handler_list */ }; +#ifdef CONFIG_BATMAN_ADV_DAT + /** * struct batadv_priv_dat - per mesh interface DAT private data * @addr: node DAT address * @hash: hashtable representing the local ARP cache * @work: work queue callback item for cache purging */ -#ifdef CONFIG_BATMAN_ADV_DAT struct batadv_priv_dat { batadv_dat_addr_t addr; struct batadv_hashtable *hash;
@@ -871,6 +875,8 @@ struct batadv_socket_packet {u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE ]; }; +#ifdef CONFIG_BATMAN_ADV_BLA +/** * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN * @orig: originator address of backbone node (mac address of primary iface)
@@ -887,7 +893,6 @@ struct batadv_socket_packet {* @refcount: number of contexts the object is used * @rcu: struct used for freeing in an RCU-safe manner */ -#ifdef CONFIG_BATMAN_ADV_BLAstruct batadv_bla_backbone_gw {u8 orig[ETH_ALEN ];unsigned short vid;
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 1/9] batman-adv: Fix kernel-doc parsing of main structs
Quoted 8 lines · On Sunday, September 06, 2015 21:38:45 Sven Eckelmann wrote:
kernel-doc is not able to skip an #ifdef between the kernel documentation block and the start of the struct. Moving the #ifdef before the kernel doc block avoids this problem
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/types.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-)
Applied in revision af45ff7.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 2/9 batman-adv: Fix kerneldoc member names in for main structs
In reply to Sven Eckelmann--- net/batman-adv/types.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
net/batman-adv/types.h +6 -6
@@ -218,12 +218,12 @@ struct batadv_orig_bat_iv {* @orig: originator ethernet address * @ifinfo_list: list for routers per outgoing interface * @last_bonding_candidate: pointer to last ifinfo of last used router -* @batadv_dat_addr_t: address of the orig node in the distributed hash +* @dat_addr: address of the orig node in the distributed hash * @last_seen: time when last packet from this node was received * @bcast_seqno_reset: time when the broadcast seqno window was reset * @mcast_handler_lock: synchronizes mcast-capability and -flag changes * @mcast_flags: multicast flags announced by the orig node -* @mcast_want_all_unsnoop_node: a list node for the +* @mcast_want_all_unsnoopables_node: a list node for the * mcast.want_all_unsnoopables list * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
@@ -405,7 +405,7 @@ struct batadv_neigh_ifinfo {/** * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression -* @orig[ETH_ALEN]: mac address of orig node orginating the broadcast +* @orig: mac address of orig node orginating the broadcast * @crc: crc32 checksum of broadcast payload * @entrytime: time when the broadcast packet was received */
@@ -554,7 +554,7 @@ struct batadv_priv_tt {/** * struct batadv_priv_bla - per mesh interface bridge loope avoidance data -* @num_requests; number of bla requests in flight +* @num_requests: number of bla requests in flight * @claim_hash: hash table containing mesh nodes this host has claimed * @backbone_hash: hash table containing all detected backbone gateways * @bcast_duplist: recently received broadcast packets array (for broadcast
@@ -777,7 +777,7 @@ struct batadv_softif_vlan {* @dat: distributed arp table data * @mcast: multicast data * @network_coding: bool indicating whether network coding is enabled -* @batadv_priv_nc: network coding data +* @nc: network coding data */ struct batadv_priv {atomic_t mesh_state;
@@ -910,7 +910,7 @@ struct batadv_bla_backbone_gw {* struct batadv_bla_claim - claimed non-mesh client structure * @addr: mac address of claimed non-mesh client * @vid: vlan id this client was detected on -* @batadv_bla_backbone_gw: pointer to backbone gw claiming this client +* @backbone_gw: pointer to backbone gw claiming this client * @lasttime: last time we heard of claim (locals only) * @hash_entry: hlist node for batadv_priv_bla::claim_hash * @refcount: number of contexts the object is used
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 2/9] batman-adv: Fix kerneldoc member names in for main structs
Quoted 4 lines · On Sunday, September 06, 2015 21:38:46 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/types.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
Applied in revision 8643c42.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 3/9 batman-adv: Remove kerneldoc for missing struct members
In reply to Sven Eckelmann--- net/batman-adv/types.h | 4 ---- 1 file changed, 4 deletions(-)
net/batman-adv/types.h +0 -4
@@ -349,9 +349,7 @@ struct batadv_gw_node {* @ifinfo_lock: lock protecting private ifinfo members and list * @if_incoming: pointer to incoming hard interface * @last_seen: when last packet via this neighbor was received -* @last_ttl: last received ttl from this neigh node * @rcu: struct used for freeing in an RCU-safe manner -* @bat_iv: B.A.T.M.A.N. IV private structure */ struct batadv_neigh_node {struct hlist_node list;
@@ -1229,8 +1227,6 @@ struct batadv_dat_candidate {* struct batadv_tvlv_container - container for tvlv appended to OGMs * @list: hlist node for batadv_priv_tvlv::container_list * @tvlv_hdr: tvlv header information needed to construct the tvlv -* @value_len: length of the buffer following this struct which contains -* the actual tvlv payload * @refcount: number of contexts the object is used */ struct batadv_tvlv_container {
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 3/9] batman-adv: Remove kerneldoc for missing struct members
Quoted 4 lines · On Sunday, September 06, 2015 21:38:47 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/types.h | 4 ---- 1 file changed, 4 deletions(-)
Applied in revision abdde59.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 4/9 batman-adv: Add kerneldoc for batadv_gw_node::refcount
In reply to Sven Eckelmann--- net/batman-adv/types.h | 1 + 1 file changed, 1 insertion(+)
net/batman-adv/types.h +1 -0
@@ -349,6 +349,7 @@ struct batadv_gw_node {* @ifinfo_lock: lock protecting private ifinfo members and list * @if_incoming: pointer to incoming hard interface * @last_seen: when last packet via this neighbor was received +* @refcount: number of contexts the object is used * @rcu: struct used for freeing in an RCU-safe manner */ struct batadv_neigh_node {
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 4/9] batman-adv: Add kerneldoc for batadv_gw_node::refcount
Quoted 4 lines · On Sunday, September 06, 2015 21:38:48 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/types.h | 1 + 1 file changed, 1 insertion(+)
Applied in revision 8c8e792.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 5/9 batman-adv: Fix kerneldoc parsing of structs/enums
In reply to Sven Eckelmann--- net/batman-adv/multicast.h | 2 +- net/batman-adv/packet.h | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-)
net/batman-adv/multicast.h +1 -1
@@ -23,7 +23,7 @@struct sk_buff ;/** -* batadv_forw_mode - the way a packet should be forwarded as +* enum batadv_forw_mode - the way a packet should be forwarded as * @BATADV_FORW_ALL: forward the packet to all nodes (currently via classic * flooding) * @BATADV_FORW_SINGLE: forward the packet to a single node (currently via the
net/batman-adv/packet.h +4 -4
@@ -159,7 +159,7 @@ enum batadv_tt_client_flags { };/** -* batadv_vlan_flags - flags for the four MSB of any vlan ID field +* enum batadv_vlan_flags - flags for the four MSB of any vlan ID field * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not */ enum batadv_vlan_flags {
@@ -231,7 +231,7 @@ struct batadv_ogm_packet {#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)/** -* batadv_icmp_header - common members among all the ICMP packets +* struct batadv_icmp_header - common members among all the ICMP packets * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header
@@ -257,7 +257,7 @@ struct batadv_icmp_header { };/** -* batadv_icmp_packet - ICMP packet +* struct batadv_icmp_packet - ICMP packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header
@@ -283,7 +283,7 @@ struct batadv_icmp_packet {#define BATADV_RR_LEN 16/** -* batadv_icmp_packet_rr - ICMP RouteRecord packet +* struct batadv_icmp_packet_rr - ICMP RouteRecord packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 5/9] batman-adv: Fix kerneldoc parsing of structs/enums
Quoted 5 lines · On Sunday, September 06, 2015 21:38:49 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/multicast.h | 2 +- net/batman-adv/packet.h | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-)
Applied in revision 5e5e8fe.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 6/9 batman-adv: Remove kerneldoc for missing parameters
In reply to Sven Eckelmann--- net/batman-adv/fragmentation.c | 1 - net/batman-adv/packet.h | 1 - net/batman-adv/routing.c | 1 - net/batman-adv/translation-table.c | 4 ---- 4 files changed, 7 deletions(-)
net/batman-adv/fragmentation.c +0 -1
@@ -242,7 +242,6 @@ err:/** * batadv_frag_merge_packets - merge a chain of fragments * @chain: head of chain with fragments -* @skb: packet with total size of skb after merging * * Expand the first skb in the chain and copy the content of the remaining * skb's into the expanded one. After doing so, clear the chain.
net/batman-adv/packet.h +0 -1
@@ -414,7 +414,6 @@ struct batadv_bcast_packet {* @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header -* @reserved: Align following fields to 2-byte boundaries * @first_source: original source of first included packet * @first_orig_dest: original destinal of first included packet * @first_crc: checksum of first included packet
net/batman-adv/routing.c +0 -1
@@ -893,7 +893,6 @@ rx_success:* batadv_recv_unicast_tvlv - receive and process unicast tvlv packets * @skb: unicast tvlv packet to process * @recv_if: pointer to interface this packet was received on -* @dst_addr: the payload destination * * Returns NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP * otherwise.
net/batman-adv/translation-table.c +0 -4
@@ -215,7 +215,6 @@ batadv_tt_global_entry_free_ref(struct batadv_tt_global_entry *tt_global_entry)/** * batadv_tt_global_hash_count - count the number of orig entries -* @hash: hash table containing the tt entries * @addr: the mac address of the client to count entries for * @vid: VLAN identifier *
@@ -300,7 +299,6 @@ static void batadv_tt_local_size_dec(struct batadv_priv *bat_priv,/** * batadv_tt_global_size_mod - change the size by v of the local table * identified by vid -* @bat_priv: the bat priv with all the soft interface information * @vid: the VLAN identifier * @v: the amount to sum to the global table size */
@@ -2400,7 +2398,6 @@ static void batadv_tt_tvlv_generate(struct batadv_priv *bat_priv,* @orig_node: originator for which the CRCs have to be checked * @tt_vlan: pointer to the first tvlv VLAN entry * @num_vlan: number of tvlv VLAN entries -* @create: if true, create VLAN objects if not found * * Return true if all the received CRCs match the locally stored ones, false * otherwise
@@ -3355,7 +3352,6 @@ out:* @tt_change: pointer to the first entry in the TT buffer * @tt_num_changes: number of tt changes inside the tt buffer * @ttvn: translation table version number of this changeset -* @tt_crc: crc32 checksum of orig node's translation table */ static void batadv_tt_update_orig(struct batadv_priv *bat_priv, struct batadv_orig_node *orig_node,
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 6/9] batman-adv: Remove kerneldoc for missing parameters
Quoted 7 lines · On Sunday, September 06, 2015 21:38:50 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/fragmentation.c | 1 - net/batman-adv/packet.h | 1 - net/batman-adv/routing.c | 1 - net/batman-adv/translation-table.c | 4 ---- 4 files changed, 7 deletions(-)
Applied in revision 54b3211.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 7/9 batman-adv: Fix names in kerneldoc of functions
In reply to Sven Eckelmann--- net/batman-adv/originator.c | 4 ++-- net/batman-adv/packet.h | 2 +- net/batman-adv/send.c | 2 +- net/batman-adv/soft-interface.c | 2 +- net/batman-adv/translation-table.c | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-)
net/batman-adv/originator.c +2 -2
@@ -366,7 +366,7 @@ out:/** * batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node -* @neigh_node: the neigh node to be queried +* @neigh: the neigh node to be queried * @if_outgoing: the interface for which the ifinfo should be acquired * * The object is returned with refcounter increased by 1.
@@ -399,7 +399,7 @@ batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,/** * batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object -* @neigh_node: the neigh node to be queried +* @neigh: the neigh node to be queried * @if_outgoing: the interface for which the ifinfo should be acquired * * Returns NULL in case of failure or the neigh_ifinfo object for the
net/batman-adv/packet.h +1 -1
@@ -495,7 +495,7 @@ struct batadv_tvlv_gateway_data {* struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container * @flags: translation table flags (see batadv_tt_data_flags) * @ttvn: translation table version number -* @vlan_num: number of announced VLANs. In the TVLV this struct is followed by +* @num_vlan: number of announced VLANs. In the TVLV this struct is followed by * one batadv_tvlv_tt_vlan_data object per announced vlan */ struct batadv_tvlv_tt_data {
net/batman-adv/send.c +1 -1
@@ -211,7 +211,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,* unicast 4addr header * @bat_priv: the bat priv with all the soft interface information * @skb: the skb containing the payload to encapsulate -* @orig_node: the destination node +* @orig: the destination node * @packet_subtype: the unicast 4addr packet subtype to use * * Returns false if the payload could not be encapsulated or true otherwise.
net/batman-adv/soft-interface.c +1 -1
@@ -480,7 +480,7 @@ out:/** * batadv_softif_vlan_free_ref - decrease the vlan object refcounter and * possibly free it -* @softif_vlan: the vlan object to release +* @vlan: the vlan object to release */ void batadv_softif_vlan_free_ref (struct batadv_softif_vlan *vlan) {
net/batman-adv/translation-table.c +2 -2
@@ -3346,8 +3346,8 @@ out:* batadv_tt_update_orig - update global translation table with new tt * information received via ogms * @bat_priv: the bat priv with all the soft interface information -* @orig: the orig_node of the ogm -* @tt_vlan: pointer to the first tvlv VLAN entry +* @orig_node: the orig_node of the ogm +* @tt_buff: pointer to the first tvlv VLAN entry * @tt_num_vlan: number of tvlv VLAN entries * @tt_change: pointer to the first entry in the TT buffer * @tt_num_changes: number of tt changes inside the tt buffer
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 7/9] batman-adv: Fix names in kerneldoc of functions
Quoted 8 lines · On Sunday, September 06, 2015 21:38:51 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/originator.c | 4 ++-- net/batman-adv/packet.h | 2 +- net/batman-adv/send.c | 2 +- net/batman-adv/soft-interface.c | 2 +- net/batman-adv/translation-table.c | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-)
Applied in revision 1388a2e.
Thanks,
Marek
Sven Eckelmann
maintainerPATCH 8/9 batman-adv: Fix kerneldoc parsing of return description
In reply to Sven Eckelmann--- net/batman-adv/bat_iv_ogm.c | 18 ++++++------ net/batman-adv/bridge_loop_avoidance.c | 6 ++-- net/batman-adv/distributed-arp-table.c | 32 ++++++++++---------- net/batman-adv/fragmentation.c | 14 ++++----- net/batman-adv/fragmentation.h | 2 +- net/batman-adv/gateway_client.c | 4 +-- net/batman-adv/gateway_common.c | 2 +- net/batman-adv/hard-interface.c | 4 +-- net/batman-adv/main.c | 20 ++++++------- net/batman-adv/main.h | 2 +- net/batman-adv/multicast.c | 20 ++++++------- net/batman-adv/network-coding.c | 42 +++++++++++++------------- net/batman-adv/originator.c | 24 +++++++-------- net/batman-adv/routing.c | 10 +++---- net/batman-adv/send.c | 14 ++++----- net/batman-adv/send.h | 4 +-- net/batman-adv/soft-interface.c | 10 +++---- net/batman-adv/sysfs.c | 10 +++---- net/batman-adv/translation-table.c | 54 +++++++++++++++++----------------- 19 files changed, 146 insertions(+), 146 deletions(-)
net/batman-adv/bat_iv_ogm.c +9 -9
@@ -88,7 +88,7 @@ static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)* in the given ring buffer * @lq_recv: pointer to the ring buffer * -* Returns computed average value. +* Return: computed average value. */ static u8 batadv_ring_buffer_avg (const u8 lq_recv[]) {
@@ -132,7 +132,7 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)* @orig_node: the orig_node that has to be changed * @max_if_num: the current amount of interfaces * -* Returns 0 on success, a negative error code otherwise. +* Return: 0 on success, a negative error code otherwise. */ static int batadv_iv_ogm_orig_add_if (struct batadv_orig_node *orig_node,int max_if_num)
@@ -180,7 +180,7 @@ unlock:* @max_if_num: the current amount of interfaces * @del_if_num: the index of the interface being removed * -* Returns 0 on success, a negative error code otherwise. +* Return: 0 on success, a negative error code otherwise. */ static int batadv_iv_ogm_orig_del_if (struct batadv_orig_node *orig_node,int max_if_num,int del_if_num)
@@ -244,7 +244,7 @@ unlock:* @bat_priv: the bat priv with all the soft interface information * @addr: mac address of the originator * -* Returns the originator object corresponding to the passed mac address or NULL +* Return: the originator object corresponding to the passed mac address or NULL * on failure. * If the object does not exists it is created an initialised. */
@@ -521,7 +521,7 @@ out:* @if_outgoing: interface for which the retransmission should be considered * @forw_packet: the forwarded packet which should be checked * -* Returns true if new_packet can be aggregated with forw_packet +* Return: true if new_packet can be aggregated with forw_packet */ static bool batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
@@ -1126,7 +1126,7 @@ out:* @if_incoming: interface where the packet was received * @if_outgoing: interface for which the retransmission should be considered * -* Returns 1 if the link can be considered bidirectional, 0 otherwise +* Return: 1 if the link can be considered bidirectional, 0 otherwise */ static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node, struct batadv_orig_node *orig_neigh_node,
@@ -1270,7 +1270,7 @@ out:* @if_incoming: interface on which the OGM packet was received * @if_outgoing: interface for which the retransmission should be considered * -* Returns duplicate status as enum batadv_dup_status +* Return: duplicate status as enum batadv_dup_status */ static enum batadv_dup_status batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
@@ -1868,7 +1868,7 @@ next:* @neigh2: the second neighbor object of the comparison * @if_outgoing2: outgoing interface for the second neighbor * -* Returns a value less, equal to or greater than 0 if the metric via neigh1 is +* Return: a value less, equal to or greater than 0 if the metric via neigh1 is * lower, the same as or higher than the metric via neigh2 */ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
@@ -1909,7 +1909,7 @@ out:* @neigh2: the second neighbor object of the comparison * @if_outgoing2: outgoing interface for the second neighbor * -* Returns true if the metric via neigh1 is equally good or better than +* Return: true if the metric via neigh1 is equally good or better than * the metric via neigh2, false otherwise. */ static bool
net/batman-adv/bridge_loop_avoidance.c +3 -3
@@ -190,7 +190,7 @@ static struct batadv_bla_claim* @addr: the address of the originator * @vid: the VLAN ID * -* Returns claim if found or NULL otherwise. +* Return: claim if found or NULL otherwise. */ static struct batadv_bla_backbone_gw * batadv_backbone_hash_find(struct batadv_priv *bat_priv, u8 *addr,
@@ -869,7 +869,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,* * Check if this is a claim frame, and process it accordingly. * -* returns 1 if it was a claim frame, otherwise return 0 to +* Return: 1 if it was a claim frame, otherwise return 0 to * tell the callee that it can use the frame on its own. */ static int batadv_bla_process_claim(struct batadv_priv *bat_priv,
@@ -1366,7 +1366,7 @@ out:* * Check if the originator is a gateway for the VLAN identified by vid. * -* Returns true if orig is a backbone for this vid, false otherwise. +* Return: true if orig is a backbone for this vid, false otherwise. */ bool batadv_bla_is_backbone_gw_orig (struct batadv_priv *bat_priv,u8 *orig,unsigned short vid)
net/batman-adv/distributed-arp-table.c +16 -16
@@ -76,7 +76,7 @@ static void batadv_dat_entry_free_ref(struct batadv_dat_entry *dat_entry)* batadv_dat_to_purge - check whether a dat_entry has to be purged or not * @dat_entry: the entry to check * -* Returns true if the entry has to be purged now, false otherwise. +* Return: true if the entry has to be purged now, false otherwise. */ static bool batadv_dat_to_purge (struct batadv_dat_entry *dat_entry) {
@@ -151,7 +151,7 @@ static void batadv_dat_purge(struct work_struct *work)* @node: node in the local table * @data2: second object to compare the node to * -* Returns 1 if the two entries are the same, 0 otherwise. +* Return: 1 if the two entries are the same, 0 otherwise. */ static int batadv_compare_dat (const struct hlist_node *node,const void *data2) {
@@ -166,7 +166,7 @@ static int batadv_compare_dat(const struct hlist_node *node, const void *data2)* @skb: ARP packet * @hdr_size: size of the possible header before the ARP packet * -* Returns the value of the hw_src field in the ARP packet. +* Return: the value of the hw_src field in the ARP packet. */ static u8 *batadv_arp_hw_src (struct sk_buff *skb,int hdr_size) {
@@ -183,7 +183,7 @@ static u8 *batadv_arp_hw_src(struct sk_buff *skb, int hdr_size)* @skb: ARP packet * @hdr_size: size of the possible header before the ARP packet * -* Returns the value of the ip_src field in the ARP packet. +* Return: the value of the ip_src field in the ARP packet. */ static __be32 batadv_arp_ip_src (struct sk_buff *skb,int hdr_size) {
@@ -195,7 +195,7 @@ static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)* @skb: ARP packet * @hdr_size: size of the possible header before the ARP packet * -* Returns the value of the hw_dst field in the ARP packet. +* Return: the value of the hw_dst field in the ARP packet. */ static u8 *batadv_arp_hw_dst (struct sk_buff *skb,int hdr_size) {
@@ -207,7 +207,7 @@ static u8 *batadv_arp_hw_dst(struct sk_buff *skb, int hdr_size)* @skb: ARP packet * @hdr_size: size of the possible header before the ARP packet * -* Returns the value of the ip_dst field in the ARP packet. +* Return: the value of the ip_dst field in the ARP packet. */ static __be32 batadv_arp_ip_dst (struct sk_buff *skb,int hdr_size) {
@@ -219,7 +219,7 @@ static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)* @data: data to hash * @size: size of the hash table * -* Returns the selected index in the hash table for the given data. +* Return: the selected index in the hash table for the given data. */ static u32 batadv_hash_dat (const void *data,u32 size) {
@@ -256,7 +256,7 @@ static u32 batadv_hash_dat(const void *data, u32 size)* @ip: search key * @vid: VLAN identifier * -* Returns the dat_entry if found, NULL otherwise. +* Return: the dat_entry if found, NULL otherwise. */ static struct batadv_dat_entry * batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip,
@@ -440,7 +440,7 @@ static void batadv_dbg_arp(struct batadv_priv *bat_priv, struct sk_buff *skb,* @candidate: orig_node under evaluation * @max_orig_node: last selected candidate * -* Returns true if the node has been elected as next candidate or false +* Return: true if the node has been elected as next candidate or false * otherwise. */ static bool batadv_is_orig_node_eligible(struct batadv_dat_candidate *res,
@@ -558,7 +558,7 @@ static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,* closest values (from the LEFT, with wrap around if needed) then the hash * value of the key. ip_dst is the key. * -* Returns the candidate array of size BATADV_DAT_CANDIDATE_NUM. +* Return: the candidate array of size BATADV_DAT_CANDIDATE_NUM. */ static struct batadv_dat_candidate *batadv_dat_select_candidates (struct batadv_priv *bat_priv,__be32 ip_dst)
@@ -599,7 +599,7 @@ batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst)* This function copies the skb with pskb_copy() and is sent as unicast packet * to each of the selected candidates. * -* Returns true if the packet is sent to at least one candidate, false +* Return: true if the packet is sent to at least one candidate, false * otherwise. */ static bool batadv_dat_send_data(struct batadv_priv *bat_priv,
@@ -828,7 +828,7 @@ out:* @skb: packet to analyse * @hdr_size: size of the possible header before the ARP packet in the skb * -* Returns the ARP type if the skb contains a valid ARP packet, 0 otherwise. +* Return: the ARP type if the skb contains a valid ARP packet, 0 otherwise. */ static u16 batadv_arp_get_type (struct batadv_priv *bat_priv,struct sk_buff *skb,int hdr_size)
@@ -927,7 +927,7 @@ static unsigned short batadv_dat_get_vid(struct sk_buff *skb, int *hdr_size)* @bat_priv: the bat priv with all the soft interface information * @skb: packet to check * -* Returns true if the message has been sent to the dht candidates, false +* Return: true if the message has been sent to the dht candidates, false * otherwise. In case of a positive return value the message has to be enqueued * to permit the fallback. */
@@ -1017,7 +1017,7 @@ out:* @skb: packet to check * @hdr_size: size of the encapsulation header * -* Returns true if the request has been answered, false otherwise. +* Return: true if the request has been answered, false otherwise. */ bool batadv_dat_snoop_incoming_arp_request (struct batadv_priv *bat_priv,struct sk_buff *skb,int hdr_size)
@@ -1140,7 +1140,7 @@ void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,* @skb: packet to check * @hdr_size: size of the encapsulation header * -* Returns true if the packet was snooped and consumed by DAT. False if the +* Return: true if the packet was snooped and consumed by DAT. False if the * packet has to be delivered to the interface */ bool batadv_dat_snoop_incoming_arp_reply(struct batadv_priv *bat_priv,
@@ -1197,7 +1197,7 @@ out:* @bat_priv: the bat priv with all the soft interface information * @forw_packet: the broadcast packet * -* Returns true if the node can drop the packet, false otherwise. +* Return: true if the node can drop the packet, false otherwise. */ bool batadv_dat_drop_broadcast_packet (struct batadv_priv *bat_priv,struct batadv_forw_packet *forw_packet)
net/batman-adv/fragmentation.c +7 -7
@@ -85,7 +85,7 @@ void batadv_frag_purge_orig(struct batadv_orig_node *orig_node,/** * batadv_frag_size_limit - maximum possible size of packet to be fragmented * -* Returns the maximum size of payload that can be fragmented. +* Return: the maximum size of payload that can be fragmented. */ static int batadv_frag_size_limit (void ) {
@@ -107,7 +107,7 @@ static int batadv_frag_size_limit(void)* * Caller must hold chain->lock. * -* Returns true if chain is empty and caller can just insert the new fragment +* Return: true if chain is empty and caller can just insert the new fragment * without searching for the right position. */ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain,
@@ -136,7 +136,7 @@ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain,* Insert a new fragment into the reverse ordered chain in the right table * entry. The hash table entry is cleared if "old" fragments exist in it. * -* Returns true if skb is buffered, false on error. If the chain has all the +* Return: true if skb is buffered, false on error. If the chain has all the * fragments needed to merge the packet, the chain is moved to the passed head * to avoid locking the chain in the table. */
@@ -246,7 +246,7 @@ err:* Expand the first skb in the chain and copy the content of the remaining * skb's into the expanded one. After doing so, clear the chain. * -* Returns the merged skb or NULL on error. +* Return: the merged skb or NULL on error. */ static struct sk_buff *batadv_frag_merge_packets (struct hlist_head *chain)
@@ -343,7 +343,7 @@ out_err:* will exceed the MTU towards the next-hop. If so, the fragment is forwarded * without merging it. * -* Returns true if the fragment is consumed/forwarded, false otherwise. +* Return: true if the fragment is consumed/forwarded, false otherwise. */ bool batadv_frag_skb_fwd(struct sk_buff *skb, struct batadv_hard_iface *recv_if,
@@ -398,7 +398,7 @@ out:* passed mtu and the old one with the rest. The new skb contains data from the * tail of the old skb. * -* Returns the new fragment, NULL on error. +* Return: the new fragment, NULL on error. */ static struct sk_buff *batadv_frag_create(struct sk_buff *skb, struct batadv_frag_packet *frag_head,
@@ -432,7 +432,7 @@ err:* @orig_node: final destination of the created fragments * @neigh_node: next-hop of the created fragments * -* Returns true on success, false otherwise. +* Return: true on success, false otherwise. */ bool batadv_frag_send_packet(struct sk_buff *skb, struct batadv_orig_node *orig_node,
net/batman-adv/fragmentation.h +1 -1
@@ -42,7 +42,7 @@ bool batadv_frag_send_packet(struct sk_buff *skb,* batadv_frag_check_entry - check if a list of fragments has timed out * @frags_entry: table entry to check * -* Returns true if the frags entry has timed out, false otherwise. +* Return: true if the frags entry has timed out, false otherwise. */ static inline bool batadv_frag_check_entry (struct batadv_frag_table_entry *frags_entry)
net/batman-adv/gateway_client.c +2 -2
@@ -456,7 +456,7 @@ static void batadv_gw_node_add(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @orig_node: originator announcing gateway capabilities * -* Returns gateway node if found or NULL otherwise. +* Return: gateway node if found or NULL otherwise. */ static struct batadv_gw_node * batadv_gw_node_get(struct batadv_priv *bat_priv,
@@ -776,7 +776,7 @@ batadv_gw_dhcp_recipient_get(struct sk_buff *skb, unsigned int *header_len,* server. Due to topology changes it may be the case that the GW server * previously selected is not the best one anymore. * -* Returns true if the packet destination is unicast and it is not the best gw, +* Return: true if the packet destination is unicast and it is not the best gw, * false otherwise. * * This call might reallocate skb data.
net/batman-adv/gateway_common.c +1 -1
@@ -38,7 +38,7 @@* @down: pointer holding the returned download bandwidth information * @up: pointer holding the returned upload bandwidth information * -* Returns false on parse error and true otherwise. +* Return: false on parse error and true otherwise. */ static bool batadv_parse_gw_bandwidth (struct net_device *net_dev,char *buff,u32 *down,u32 *up)
net/batman-adv/hard-interface.c +2 -2
@@ -84,7 +84,7 @@ out:* This function recursively checks all the fathers of the device passed as * argument looking for a batman-adv soft interface. * -* Returns true if the device is descendant of a batman-adv mesh interface (or +* Return: true if the device is descendant of a batman-adv mesh interface (or * if it is a batman-adv interface itself), false otherwise */ static bool batadv_is_on_batman_iface (const struct net_device *net_dev)
@@ -135,7 +135,7 @@ static int batadv_is_valid_iface(const struct net_device *net_dev)* interface * @net_device: the device to check * -* Returns true if the net device is a 802.11 wireless device, false otherwise. +* Return: true if the net device is a 802.11 wireless device, false otherwise. */ bool batadv_is_wifi_netdev (struct net_device *net_device) {
net/batman-adv/main.c +10 -10
@@ -233,7 +233,7 @@ void batadv_mesh_free(struct net_device *soft_iface)* @bat_priv: the bat priv with all the soft interface information * @addr: the address to check * -* Returns 'true' if the mac address was found, false otherwise. +* Return: 'true' if the mac address was found, false otherwise. */ bool batadv_is_my_mac (struct batadv_priv *bat_priv,const u8 *addr) {
@@ -262,7 +262,7 @@ bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)* function that requires the primary interface * @seq: debugfs table seq_file struct * -* Returns primary interface if found or NULL otherwise. +* Return: primary interface if found or NULL otherwise. */ struct batadv_hard_iface *batadv_seq_print_text_primary_if_get (struct seq_file *seq)
@@ -640,7 +640,7 @@ batadv_tvlv_handler_free_ref(struct batadv_tvlv_handler *tvlv_handler)* @type: tvlv handler type to look for * @version: tvlv handler version to look for * -* Returns tvlv handler if found or NULL otherwise. +* Return: tvlv handler if found or NULL otherwise. */ static struct batadv_tvlv_handler *batadv_tvlv_handler_get (struct batadv_priv *bat_priv,u8 type,u8 version)
@@ -688,7 +688,7 @@ static void batadv_tvlv_container_free_ref(struct batadv_tvlv_container *tvlv)* Has to be called with the appropriate locks being acquired * (tvlv.container_list_lock). * -* Returns tvlv container if found or NULL otherwise. +* Return: tvlv container if found or NULL otherwise. */ static struct batadv_tvlv_container *batadv_tvlv_container_get (struct batadv_priv *bat_priv,u8 type,u8 version)
@@ -720,7 +720,7 @@ static struct batadv_tvlv_container* Has to be called with the appropriate locks being acquired * (tvlv.container_list_lock). * -* Returns size of all currently registered tvlv containers in bytes. +* Return: size of all currently registered tvlv containers in bytes. */ static u16 batadv_tvlv_container_list_size (struct batadv_priv *bat_priv) {
@@ -826,7 +826,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv,* @additional_packet_len: requested additional packet size on top of minimum * size * -* Returns true of the packet buffer could be changed to the requested size, +* Return: true of the packet buffer could be changed to the requested size, * false otherwise. */ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
@@ -862,7 +862,7 @@ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,* The ogm packet might be enlarged or shrunk depending on the current size * and the size of the to-be-appended tvlv containers. * -* Returns size of all appended tvlv containers in bytes. +* Return: size of all appended tvlv containers in bytes. */ u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv, unsigned char **packet_buff,
@@ -915,7 +915,7 @@ end:* @tvlv_value: tvlv content * @tvlv_value_len: tvlv content length * -* Returns success if handler was not found or the return value of the handler +* Return: success if handler was not found or the return value of the handler * callback. */ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
@@ -968,7 +968,7 @@ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,* @tvlv_value: tvlv content * @tvlv_value_len: tvlv content length * -* Returns success when processing an OGM or the return value of all called +* Return: success when processing an OGM or the return value of all called * handler callbacks. */ int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
@@ -1223,7 +1223,7 @@ unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)* @vid: the VLAN identifier for which the AP isolation attributed as to be * looked up * -* Returns true if AP isolation is on for the VLAN idenfied by vid, false +* Return: true if AP isolation is on for the VLAN idenfied by vid, false * otherwise */ bool batadv_vlan_ap_isola_get (struct batadv_priv *bat_priv,unsigned short vid)
net/batman-adv/main.h +1 -1
@@ -287,7 +287,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2)* @timestamp: base value to compare with (in jiffies) * @timeout: added to base value before comparing (in milliseconds) * -* Returns true if current time is after timestamp + timeout +* Return: true if current time is after timestamp + timeout */ static inline bool batadv_has_timed_out (unsigned long timestamp,unsigned int timeout)
net/batman-adv/multicast.c +10 -10
@@ -55,7 +55,7 @@* Collect multicast addresses of the local multicast listeners * on the given soft interface, dev, in the given mcast_list. * -* Returns -ENOMEM on memory allocation error or the number of +* Return: -ENOMEM on memory allocation error or the number of * items added to the mcast_list otherwise. */ static int batadv_mcast_mla_softif_get(struct net_device *dev,
@@ -87,7 +87,7 @@ static int batadv_mcast_mla_softif_get(struct net_device *dev,* @mcast_addr: the multicast address to check * @mcast_list: the list with multicast addresses to search in * -* Returns true if the given address is already in the given list. +* Return: true if the given address is already in the given list. * Otherwise returns false. */ static bool batadv_mcast_mla_is_duplicate(u8 *mcast_addr,
@@ -218,7 +218,7 @@ static bool batadv_mcast_has_bridge(struct batadv_priv *bat_priv)* Updates the own multicast tvlv with our current multicast related settings, * capabilities and inabilities. * -* Returns true if the tvlv container is registered afterwards. Otherwise +* Return: true if the tvlv container is registered afterwards. Otherwise * returns false. */ static bool batadv_mcast_mla_tvlv_update (struct batadv_priv *bat_priv)
@@ -398,7 +398,7 @@ static int batadv_mcast_forw_mode_check(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @ethhdr: ethernet header of a packet * -* Returns the number of nodes which want all IPv4 multicast traffic if the +* Return: the number of nodes which want all IPv4 multicast traffic if the * given ethhdr is from an IPv4 packet or the number of nodes which want all * IPv6 traffic if it matches an IPv6 packet. */
@@ -421,7 +421,7 @@ static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @ethhdr: the ether header containing the multicast destination * -* Returns an orig_node matching the multicast address provided by ethhdr +* Return: an orig_node matching the multicast address provided by ethhdr * via a translation table lookup. This increases the returned nodes refcount. */ static struct batadv_orig_node *
@@ -436,7 +436,7 @@ batadv_mcast_forw_tt_node_get(struct batadv_priv *bat_priv,* batadv_mcast_want_forw_ipv4_node_get - get a node with an ipv4 flag * @bat_priv: the bat priv with all the soft interface information * -* Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and +* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and * increases its refcount. */ static struct batadv_orig_node *
@@ -463,7 +463,7 @@ batadv_mcast_forw_ipv4_node_get(struct batadv_priv *bat_priv)* batadv_mcast_want_forw_ipv6_node_get - get a node with an ipv6 flag * @bat_priv: the bat priv with all the soft interface information * -* Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set +* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set * and increases its refcount. */ static struct batadv_orig_node *
@@ -491,7 +491,7 @@ batadv_mcast_forw_ipv6_node_get(struct batadv_priv *bat_priv)* @bat_priv: the bat priv with all the soft interface information * @ethhdr: an ethernet header to determine the protocol family from * -* Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 or +* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 or * BATADV_MCAST_WANT_ALL_IPV6 flag, depending on the provided ethhdr, set and * increases its refcount. */
@@ -514,7 +514,7 @@ batadv_mcast_forw_ip_node_get(struct batadv_priv *bat_priv,* batadv_mcast_want_forw_unsnoop_node_get - get a node with an unsnoopable flag * @bat_priv: the bat priv with all the soft interface information * -* Returns an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag +* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag * set and increases its refcount. */ static struct batadv_orig_node *
@@ -543,7 +543,7 @@ batadv_mcast_forw_unsnoop_node_get(struct batadv_priv *bat_priv)* @skb: The multicast packet to check * @orig: an originator to be set to forward the skb to * -* Returns the forwarding mode as enum batadv_forw_mode and in case of +* Return: the forwarding mode as enum batadv_forw_mode and in case of * BATADV_FORW_SINGLE set the orig to the single originator the skb * should be forwarded to. */
net/batman-adv/network-coding.c +21 -21
168 lines not on this page · raw message
net/batman-adv/originator.c +12 -12
@@ -61,7 +61,7 @@ int batadv_compare_orig(const struct hlist_node *node, const void *data2)* @orig_node: the originator serving the VLAN * @vid: the VLAN identifier * -* Returns the vlan object identified by vid and belonging to orig_node or NULL +* Return: the vlan object identified by vid and belonging to orig_node or NULL * if it does not exist. */ struct batadv_orig_node_vlan *
@@ -93,7 +93,7 @@ batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,* @orig_node: the originator serving the VLAN * @vid: the VLAN identifier * -* Returns NULL in case of failure or the vlan object identified by vid and +* Return: NULL in case of failure or the vlan object identified by vid and * belonging to orig_node otherwise. The object is created and added to the list * if it does not exist. *
@@ -257,7 +257,7 @@ void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node)* @if_outgoing: the interface where the payload packet has been received or * the OGM should be sent to * -* Returns the neighbor which should be router for this orig_node/iface. +* Return: the neighbor which should be router for this orig_node/iface. * * The object is returned with refcounter increased by 1. */
@@ -289,7 +289,7 @@ batadv_orig_router_get(struct batadv_orig_node *orig_node,* @orig_node: the orig node to be queried * @if_outgoing: the interface for which the ifinfo should be acquired * -* Returns the requested orig_ifinfo or NULL if not found. +* Return: the requested orig_ifinfo or NULL if not found. * * The object is returned with refcounter increased by 1. */
@@ -321,7 +321,7 @@ batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,* @orig_node: the orig node to be queried * @if_outgoing: the interface for which the ifinfo should be acquired * -* Returns NULL in case of failure or the orig_ifinfo object for the if_outgoing +* Return: NULL in case of failure or the orig_ifinfo object for the if_outgoing * interface otherwise. The object is created and added to the list * if it does not exist. *
@@ -371,7 +371,7 @@ out:* * The object is returned with refcounter increased by 1. * -* Returns the requested neigh_ifinfo or NULL if not found +* Return: the requested neigh_ifinfo or NULL if not found */ struct batadv_neigh_ifinfo * batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
@@ -402,7 +402,7 @@ batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,* @neigh: the neigh node to be queried * @if_outgoing: the interface for which the ifinfo should be acquired * -* Returns NULL in case of failure or the neigh_ifinfo object for the +* Return: NULL in case of failure or the neigh_ifinfo object for the * if_outgoing interface otherwise. The object is created and added to the list * if it does not exist. *
@@ -792,7 +792,7 @@ batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @orig_node: orig node which is to be checked * -* Returns true if any ifinfo entry was purged, false otherwise. +* Return: true if any ifinfo entry was purged, false otherwise. */ static bool batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
@@ -844,7 +844,7 @@ batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @orig_node: orig node which is to be checked * -* Returns true if any neighbor was purged, false otherwise +* Return: true if any neighbor was purged, false otherwise */ static bool batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
@@ -903,7 +903,7 @@ batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,* @orig_node: orig node which is to be checked * @if_outgoing: the interface for which the metric should be compared * -* Returns the current best neighbor, with refcount increased. +* Return: the current best neighbor, with refcount increased. */ static struct batadv_neigh_node * batadv_find_best_neighbor(struct batadv_priv *bat_priv,
@@ -940,7 +940,7 @@ batadv_find_best_neighbor(struct batadv_priv *bat_priv,* This function checks if the orig_node or substructures of it have become * obsolete, and purges this information if that's the case. * -* Returns true if the orig_node is to be removed, false otherwise. +* Return: true if the orig_node is to be removed, false otherwise. */ static bool batadv_purge_orig_node (struct batadv_priv *bat_priv,struct batadv_orig_node *orig_node)
@@ -1085,7 +1085,7 @@ int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)* @seq: debugfs table seq_file struct * @offset: not used * -* Returns 0 +* Return: 0 */ int batadv_orig_hardif_seq_print_text (struct seq_file *seq,void *offset) {
net/batman-adv/routing.c +5 -5
@@ -198,7 +198,7 @@ bool batadv_check_management_packet(struct sk_buff *skb,* @bat_priv: the bat priv with all the soft interface information * @skb: icmp packet to process * -* Returns NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP +* Return: NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP * otherwise. */ static int batadv_recv_my_icmp_packet(struct batadv_priv *bat_priv,
@@ -435,7 +435,7 @@ static int batadv_check_unicast_packet(struct batadv_priv *bat_priv,* @orig_node: the destination node * @recv_if: pointer to interface this packet was received on * -* Returns the router which should be used for this orig_node on +* Return: the router which should be used for this orig_node on * this interface, or NULL if not available. */ struct batadv_neigh_node *
@@ -648,7 +648,7 @@ out:* the new corresponding information (originator address where the destination * client currently is and its known TTVN) * -* Returns true if the packet header has been updated, false otherwise +* Return: true if the packet header has been updated, false otherwise */ static bool batadv_reroute_unicast_packet(struct batadv_priv *bat_priv,
@@ -805,7 +805,7 @@ static int batadv_check_unicast_ttvn(struct batadv_priv *bat_priv,* @skb: unicast tvlv packet to process * @recv_if: pointer to interface this packet was received on * -* Returns NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP +* Return: NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP * otherwise. */ int batadv_recv_unhandled_unicast_packet(struct sk_buff *skb,
@@ -894,7 +894,7 @@ rx_success:* @skb: unicast tvlv packet to process * @recv_if: pointer to interface this packet was received on * -* Returns NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP +* Return: NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP * otherwise. */ int batadv_recv_unicast_tvlv(struct sk_buff *skb,
net/batman-adv/send.c +7 -7
@@ -111,7 +111,7 @@ send_skb_err:* host, NULL can be passed as recv_if and no interface alternating is * attempted. * -* Returns NET_XMIT_SUCCESS on success, NET_XMIT_DROP on failure, or +* Return: NET_XMIT_SUCCESS on success, NET_XMIT_DROP on failure, or * NET_XMIT_POLICED if the skb is buffered for later transmit. */ int batadv_send_skb_to_orig(struct sk_buff *skb,
@@ -165,7 +165,7 @@ out:* @hdr_size: amount of bytes to push at the beginning of the skb * @orig_node: the destination node * -* Returns false if the buffer extension was not possible or true otherwise. +* Return: false if the buffer extension was not possible or true otherwise. */ static bool batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,
@@ -196,7 +196,7 @@ batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,* @skb: the skb containing the payload to encapsulate * @orig_node: the destination node * -* Returns false if the payload could not be encapsulated or true otherwise. +* Return: false if the payload could not be encapsulated or true otherwise. */ static bool batadv_send_skb_prepare_unicast (struct sk_buff *skb,struct batadv_orig_node *orig_node)
@@ -214,7 +214,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,* @orig: the destination node * @packet_subtype: the unicast 4addr packet subtype to use * -* Returns false if the payload could not be encapsulated or true otherwise. +* Return: false if the payload could not be encapsulated or true otherwise. */ bool batadv_send_skb_prepare_unicast_4addr(struct batadv_priv *bat_priv, struct sk_buff *skb,
@@ -265,7 +265,7 @@ out:* as packet_type. Then send this frame to the given orig_node and release a * reference to this orig_node. * -* Returns NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. +* Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. */ int batadv_send_skb_unicast(struct batadv_priv *bat_priv, struct sk_buff *skb, int packet_type,
@@ -339,7 +339,7 @@ out:* BATADV_UNICAST_4ADDR was supplied as packet_type. Then send this frame * to the according destination node. * -* Returns NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. +* Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. */ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv, struct sk_buff *skb, int packet_type,
@@ -373,7 +373,7 @@ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv,* Look up the currently selected gateway. Wrap the given skb into a batman-adv * unicast header and send this frame to this gateway node. * -* Returns NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. +* Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. */ int batadv_send_skb_via_gw (struct batadv_priv *bat_priv,struct sk_buff *skb,unsigned short vid)
net/batman-adv/send.h +2 -2
@@ -69,7 +69,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,* header via the translation table. Wrap the given skb into a batman-adv * unicast header. Then send this frame to the according destination node. * -* Returns NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. +* Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. */ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv, struct sk_buff *skb, u8 *dst_hint,
@@ -92,7 +92,7 @@ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv,* unicast-4addr header. Then send this frame to the according destination * node. * -* Returns NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. +* Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise. */ static inline int batadv_send_skb_via_tt_4addr(struct batadv_priv *bat_priv, struct sk_buff *skb,
net/batman-adv/soft-interface.c +5 -5
@@ -501,7 +501,7 @@ void batadv_softif_vlan_free_ref(struct batadv_softif_vlan *vlan)* @bat_priv: the bat priv with all the soft interface information * @vid: the identifier of the vlan object to retrieve * -* Returns the private data of the vlan matching the vid passed as argument or +* Return: the private data of the vlan matching the vid passed as argument or * NULL otherwise. The refcounter of the returned object is incremented by 1. */ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
@@ -530,7 +530,7 @@ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,* @bat_priv: the bat priv with all the soft interface information * @vid: the VLAN identifier * -* Returns 0 on success, a negative error otherwise. +* Return: 0 on success, a negative error otherwise. */ int batadv_softif_create_vlan (struct batadv_priv *bat_priv,unsigned short vid) {
@@ -599,7 +599,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,* Set up all the internal structures for handling the new vlan on top of the * mesh interface * -* Returns 0 on success or a negative error code in case of failure. +* Return: 0 on success or a negative error code in case of failure. */ static int batadv_interface_add_vid (struct net_device *dev,__be16 proto,unsigned short vid)
@@ -656,7 +656,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,* Destroy all the internal structures used to handle the vlan identified by vid * on top of the mesh interface * -* Returns 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q +* Return: 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q * or -ENOENT if the specified vlan id wasn't registered. */ static int batadv_interface_kill_vid(struct net_device *dev, __be16 proto,
@@ -745,7 +745,7 @@ static void batadv_softif_destroy_finish(struct work_struct *work)* batadv_softif_init_late - late stage initialization of soft interface * @dev: registered network device to modify * -* Returns error code on failures +* Return: error code on failures */ static int batadv_softif_init_late (struct net_device *dev) {
net/batman-adv/sysfs.c +5 -5
@@ -63,7 +63,7 @@ static struct batadv_priv *batadv_kobj_to_batpriv(struct kobject *obj)* batadv_vlan_kobj_to_batpriv - convert a vlan kobj in the associated batpriv * @obj: kobject to covert * -* Returns the associated batadv_priv struct. +* Return: the associated batadv_priv struct. */ static struct batadv_priv *batadv_vlan_kobj_to_batpriv (struct kobject *obj) {
@@ -83,7 +83,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj)* batadv_kobj_to_vlan - convert a kobj in the associated softif_vlan struct * @obj: kobject to covert * -* Returns the associated softif_vlan struct if found, NULL otherwise. +* Return: the associated softif_vlan struct if found, NULL otherwise. */ static struct batadv_softif_vlan *batadv_kobj_to_vlan (struct batadv_priv *bat_priv,struct kobject *obj)
@@ -484,7 +484,7 @@ static ssize_t batadv_store_gw_bwidth(struct kobject *kobj,* @attr: the batman-adv attribute the user is interacting with * @buff: the buffer that will contain the data to send back to the user * -* Returns the number of bytes written into 'buff' on success or a negative +* Return: the number of bytes written into 'buff' on success or a negative * error code in case of failure */ static ssize_t batadv_show_isolation_mark(struct kobject *kobj,
@@ -504,7 +504,7 @@ static ssize_t batadv_show_isolation_mark(struct kobject *kobj,* @buff: the buffer containing the user data * @count: number of bytes in the buffer * -* Returns 'count' on success or a negative error code in case of failure +* Return: 'count' on success or a negative error code in case of failure */ static ssize_t batadv_store_isolation_mark(struct kobject *kobj, struct attribute *attr, char *buff,
@@ -675,7 +675,7 @@ void batadv_sysfs_del_meshif(struct net_device *dev)* @dev: netdev of the mesh interface * @vlan: private data of the newly added VLAN interface * -* Returns 0 on success and -ENOMEM if any of the structure allocations fails. +* Return: 0 on success and -ENOMEM if any of the structure allocations fails. */ int batadv_sysfs_add_vlan (struct net_device *dev,struct batadv_softif_vlan *vlan)
net/batman-adv/translation-table.c +27 -27
216 lines not on this page · raw message
Signature · 1 line
2.5.1
Sven Eckelmann
maintainerPATCH 9/9 batman-adv: Drop invalid kerneldoc for variable batadv_vlan_attrs
In reply to Sven Eckelmann--- net/batman-adv/sysfs.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
net/batman-adv/sysfs.c +1 -3
@@ -612,9 +612,7 @@ static struct batadv_attribute *batadv_mesh_attrs[] = {BATADV_ATTR_VLAN_BOOL (ap_isolation,S_IRUGO |S_IWUSR ,NULL ); -/** -* batadv_vlan_attrs - array of vlan specific sysfs attributes -*/ +/* array of vlan specific sysfs attributes */ static struct batadv_attribute *batadv_vlan_attrs[] = { &batadv_attr_vlan_ap_isolation,NULL ,
Signature · 1 line
2.5.1
Marek Lindner
AppliedRe: [B.A.T.M.A.N.] [PATCH 9/9] batman-adv: Drop invalid kerneldoc for variable batadv_vlan_attrs
Quoted 4 lines · On Sunday, September 06, 2015 21:38:53 Sven Eckelmann wrote:
Signed-off-by Sven Eckelmann <[email protected]>--- net/batman-adv/sysfs.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
Applied in revision cb6dfb4.
Thanks,
Marek