Commit d8141208 authored by Andrew Lunn's avatar Andrew Lunn Committed by David S. Miller
Browse files

net: tipc: kerneldoc fixes 



Simple fixes which require no deep knowledge of the code.

Cc: Jon Maloy <jmaloy@redhat.com>
Cc: Ying Xue <ying.xue@windriver.com>
Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>
Acked-by: default avatarJon Maloy <jmaloy@redhat.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent c8af73f0

net/tipc/bearer.c

+1 −1
Original line number Diff line number Diff line
@@ -595,7 +595,7 @@ void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id, 


/**

 * tipc_l2_rcv_msg - handle incoming TIPC message from an interface

 * @buf: the received packet

 * @skb: the received message

 * @dev: the net device that the packet was received on

 * @pt: the packet_type structure which was used to register this handler

 * @orig_dev: the original receive net device in case the device is a bond

net/tipc/discover.c

+2 −3
Original line number Diff line number Diff line
@@ -74,7 +74,7 @@ struct tipc_discoverer { 
/**

 * tipc_disc_init_msg - initialize a link setup message

 * @net: the applicable net namespace

 * @type: message type (request or response)

 * @mtyp: message type (request or response)

 * @b: ptr to bearer issuing message

 */

static void tipc_disc_init_msg(struct net *net, struct sk_buff *skb,
@@ -339,7 +339,7 @@ static void tipc_disc_timeout(struct timer_list *t) 
 * @net: the applicable net namespace

 * @b: ptr to bearer issuing requests

 * @dest: destination address for request messages

 * @dest_domain: network domain to which links can be established

 * @skb: pointer to created frame

 *

 * Returns 0 if successful, otherwise -errno.

 */
@@ -393,7 +393,6 @@ void tipc_disc_delete(struct tipc_discoverer *d) 
 * tipc_disc_reset - reset object to send periodic link setup requests

 * @net: the applicable net namespace

 * @b: ptr to bearer issuing requests

 * @dest_domain: network domain to which links can be established

 */

void tipc_disc_reset(struct net *net, struct tipc_bearer *b)

{

net/tipc/link.c

+3 −3
Original line number Diff line number Diff line
@@ -445,7 +445,7 @@ u32 tipc_link_state(struct tipc_link *l) 


/**

 * tipc_link_create - create a new link

 * @n: pointer to associated node

 * @net: pointer to associated network namespace

 * @if_name: associated interface name

 * @bearer_id: id (index) of associated bearer

 * @tolerance: link tolerance to be used by link
@@ -530,7 +530,7 @@ bool tipc_link_create(struct net *net, char *if_name, int bearer_id, 


/**

 * tipc_link_bc_create - create new link to be used for broadcast

 * @n: pointer to associated node

 * @net: pointer to associated network namespace

 * @mtu: mtu to be used initially if no peers

 * @window: send window to be used

 * @inputq: queue to put messages ready for delivery
@@ -989,7 +989,7 @@ void tipc_link_reset(struct tipc_link *l) 


/**

 * tipc_link_xmit(): enqueue buffer list according to queue situation

 * @link: link to use

 * @l: link to use

 * @list: chain of buffers containing message

 * @xmitq: returned list of packets to be sent by caller

 *

net/tipc/msg.c

+1 −1
Original line number Diff line number Diff line
@@ -202,7 +202,7 @@ int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf) 


/**

 * tipc_msg_append(): Append data to tail of an existing buffer queue

 * @hdr: header to be used

 * @_hdr: header to be used

 * @m: the data to be appended

 * @mss: max allowable size of buffer

 * @dlen: size of data to be appended

net/tipc/node.c

+2 −2
Original line number Diff line number Diff line
@@ -1515,7 +1515,7 @@ static void node_lost_contact(struct tipc_node *n, 
 * tipc_node_get_linkname - get the name of a link

 *

 * @bearer_id: id of the bearer

 * @node: peer node address

 * @addr: peer node address

 * @linkname: link name output buffer

 *

 * Returns 0 on success
@@ -2022,7 +2022,7 @@ static bool tipc_node_check_state(struct tipc_node *n, struct sk_buff *skb, 
 * tipc_rcv - process TIPC packets/messages arriving from off-node

 * @net: the applicable net namespace

 * @skb: TIPC packet

 * @bearer: pointer to bearer message arrived on

 * @b: pointer to bearer message arrived on

 *

 * Invoked with no locks held. Bearer pointer must point to a valid bearer

 * structure (i.e. cannot be NULL), but bearer can be inactive.