Commit 637b77fd authored by Randy Dunlap's avatar Randy Dunlap Committed by Jakub Kicinski
Browse files

net/tipc: fix all function Return: notation 



Fix Return: kernel-doc notation in all net/tipc/ source files.
Also keep ReST list notation intact for output formatting.
Fix a few typos in comments.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent f172f4b8

net/tipc/bearer.c

+1 −1
Original line number Diff line number Diff line
@@ -132,7 +132,7 @@ int tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a) 
 * @name: ptr to bearer name string

 * @name_parts: ptr to area for bearer name components (or NULL if not needed)

 *

 * Returns 1 if bearer name is valid, otherwise 0.

 * Return: 1 if bearer name is valid, otherwise 0.

 */

static int bearer_name_validate(const char *name,

				struct tipc_bearer_names *name_parts)

net/tipc/crypto.c

+19 −19
Original line number Diff line number Diff line
@@ -721,9 +721,9 @@ static void *tipc_aead_mem_alloc(struct crypto_aead *tfm, 
 * @__dnode: TIPC dest node if "known"

 *

 * Return:

 * 0                   : if the encryption has completed

 * -EINPROGRESS/-EBUSY : if a callback will be performed

 * < 0                 : the encryption has failed

 * * 0                   : if the encryption has completed

 * * -EINPROGRESS/-EBUSY : if a callback will be performed

 * * < 0                 : the encryption has failed

 */

static int tipc_aead_encrypt(struct tipc_aead *aead, struct sk_buff *skb,

			     struct tipc_bearer *b,
@@ -877,9 +877,9 @@ static void tipc_aead_encrypt_done(struct crypto_async_request *base, int err) 
 * @b: TIPC bearer where the message has been received

 *

 * Return:

 * 0                   : if the decryption has completed

 * -EINPROGRESS/-EBUSY : if a callback will be performed

 * < 0                 : the decryption has failed

 * * 0                   : if the decryption has completed

 * * -EINPROGRESS/-EBUSY : if a callback will be performed

 * * < 0                 : the decryption has failed

 */

static int tipc_aead_decrypt(struct net *net, struct tipc_aead *aead,

			     struct sk_buff *skb, struct tipc_bearer *b)
@@ -1008,7 +1008,7 @@ static inline int tipc_ehdr_size(struct tipc_ehdr *ehdr) 
 * tipc_ehdr_validate - Validate an encryption message

 * @skb: the message buffer

 *

 * Returns "true" if this is a valid encryption message, otherwise "false"

 * Return: "true" if this is a valid encryption message, otherwise "false"

 */

bool tipc_ehdr_validate(struct sk_buff *skb)

{
@@ -1681,12 +1681,12 @@ static inline void tipc_crypto_clone_msg(struct net *net, struct sk_buff *_skb, 
 * Otherwise, the skb is freed!

 *

 * Return:

 * 0                   : the encryption has succeeded (or no encryption)

 * -EINPROGRESS/-EBUSY : the encryption is ongoing, a callback will be made

 * -ENOKEK             : the encryption has failed due to no key

 * -EKEYREVOKED        : the encryption has failed due to key revoked

 * -ENOMEM             : the encryption has failed due to no memory

 * < 0                 : the encryption has failed due to other reasons

 * * 0                   : the encryption has succeeded (or no encryption)

 * * -EINPROGRESS/-EBUSY : the encryption is ongoing, a callback will be made

 * * -ENOKEK             : the encryption has failed due to no key

 * * -EKEYREVOKED        : the encryption has failed due to key revoked

 * * -ENOMEM             : the encryption has failed due to no memory

 * * < 0                 : the encryption has failed due to other reasons

 */

int tipc_crypto_xmit(struct net *net, struct sk_buff **skb,

		     struct tipc_bearer *b, struct tipc_media_addr *dst,
@@ -1806,12 +1806,12 @@ int tipc_crypto_xmit(struct net *net, struct sk_buff **skb, 
 * cluster key(s) can be taken for decryption (- recursive).

 *

 * Return:

 * 0                   : the decryption has successfully completed

 * -EINPROGRESS/-EBUSY : the decryption is ongoing, a callback will be made

 * -ENOKEY             : the decryption has failed due to no key

 * -EBADMSG            : the decryption has failed due to bad message

 * -ENOMEM             : the decryption has failed due to no memory

 * < 0                 : the decryption has failed due to other reasons

 * * 0                   : the decryption has successfully completed

 * * -EINPROGRESS/-EBUSY : the decryption is ongoing, a callback will be made

 * * -ENOKEY             : the decryption has failed due to no key

 * * -EBADMSG            : the decryption has failed due to bad message

 * * -ENOMEM             : the decryption has failed due to no memory

 * * < 0                 : the decryption has failed due to other reasons

 */

int tipc_crypto_rcv(struct net *net, struct tipc_crypto *rx,

		    struct sk_buff **skb, struct tipc_bearer *b)

net/tipc/discover.c

+1 −1
Original line number Diff line number Diff line
@@ -342,7 +342,7 @@ static void tipc_disc_timeout(struct timer_list *t) 
 * @dest: destination address for request messages

 * @skb: pointer to created frame

 *

 * Returns 0 if successful, otherwise -errno.

 * Return: 0 if successful, otherwise -errno.

 */

int tipc_disc_create(struct net *net, struct tipc_bearer *b,

		     struct tipc_media_addr *dest, struct sk_buff **skb)

net/tipc/link.c

+4 −4
Original line number Diff line number Diff line
@@ -488,7 +488,7 @@ u32 tipc_link_state(struct tipc_link *l) 
 * @self: local unicast link id

 * @peer_id: 128-bit ID of peer

 *

 * Returns true if link was created, otherwise false

 * Return: true if link was created, otherwise false

 */

bool tipc_link_create(struct net *net, char *if_name, int bearer_id,

		      int tolerance, char net_plane, u32 mtu, int priority,
@@ -567,7 +567,7 @@ bool tipc_link_create(struct net *net, char *if_name, int bearer_id, 
 * @peer_caps: bitmap describing peer node capabilities

 * @bc_sndlink: the namespace global link used for broadcast sending

 *

 * Returns true if link was created, otherwise false

 * Return: true if link was created, otherwise false

 */

bool tipc_link_bc_create(struct net *net, u32 ownnode, u32 peer, u8 *peer_id,

			 int mtu, u32 min_win, u32 max_win, u16 peer_caps,
@@ -822,7 +822,7 @@ static void link_profile_stats(struct tipc_link *l) 
 * tipc_link_too_silent - check if link is "too silent"

 * @l: tipc link to be checked

 *

 * Returns true if the link 'silent_intv_cnt' is about to reach the

 * Return: true if the link 'silent_intv_cnt' is about to reach the

 * 'abort_limit' value, otherwise false

 */

bool tipc_link_too_silent(struct tipc_link *l)
@@ -1024,8 +1024,8 @@ void tipc_link_reset(struct tipc_link *l) 
 * @xmitq: returned list of packets to be sent by caller

 *

 * Consumes the buffer chain.

 * Returns 0 if success, or errno: -ELINKCONG, -EMSGSIZE or -ENOBUFS

 * Messages at TIPC_SYSTEM_IMPORTANCE are always accepted

 * Return: 0 if success, or errno: -ELINKCONG, -EMSGSIZE or -ENOBUFS

 */

int tipc_link_xmit(struct tipc_link *l, struct sk_buff_head *list,

		   struct sk_buff_head *xmitq)

net/tipc/msg.c

+10 −9
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ static unsigned int align(unsigned int i) 
 * @size: message size (including TIPC header)

 * @gfp: memory allocation flags

 *

 * Returns a new buffer with data pointers set to the specified size.

 * Return: a new buffer with data pointers set to the specified size.

 *

 * NOTE:

 * Headroom is reserved to allow prepending of a data link header.
@@ -209,8 +209,9 @@ int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf) 
 * @m: the data to be appended

 * @mss: max allowable size of buffer

 * @dlen: size of data to be appended

 * @txq: queue to appand to

 * Returns the number og 1k blocks appended or errno value

 * @txq: queue to append to

 *

 * Return: the number of 1k blocks appended or errno value

 */

int tipc_msg_append(struct tipc_msg *_hdr, struct msghdr *m, int dlen,

		    int mss, struct sk_buff_head *txq)
@@ -314,7 +315,7 @@ bool tipc_msg_validate(struct sk_buff **_skb) 
 * @pktmax: max size of a fragment incl. the header

 * @frags: returned fragment skb list

 *

 * Returns 0 if the fragmentation is successful, otherwise: -EINVAL

 * Return: 0 if the fragmentation is successful, otherwise: -EINVAL

 * or -ENOMEM

 */

int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr,
@@ -377,7 +378,7 @@ int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr, 
 * Note that the recursive call we are making here is safe, since it can

 * logically go only one further level down.

 *

 * Returns message data size or errno: -ENOMEM, -EFAULT

 * Return: message data size or errno: -ENOMEM, -EFAULT

 */

int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m, int offset,

		   int dsz, int pktmax, struct sk_buff_head *list)
@@ -488,7 +489,7 @@ int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m, int offset, 
 * @msg: message to be appended

 * @max: max allowable size for the bundle buffer

 *

 * Returns "true" if bundling has been performed, otherwise "false"

 * Return: "true" if bundling has been performed, otherwise "false"

 */

static bool tipc_msg_bundle(struct sk_buff *bskb, struct tipc_msg *msg,

			    u32 max)
@@ -585,7 +586,7 @@ bool tipc_msg_try_bundle(struct sk_buff *tskb, struct sk_buff **skb, u32 mss, 
 *  @pos: position in outer message of msg to be extracted.

 *  Returns position of next msg.

 *  Consumes outer buffer when last packet extracted

 *  Returns true when there is an extracted buffer, otherwise false

 *  Return: true when there is an extracted buffer, otherwise false

 */

bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos)

{
@@ -629,7 +630,7 @@ bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos) 
 * @skb:  buffer containing message to be reversed; will be consumed

 * @err:  error code to be set in message, if any

 * Replaces consumed buffer with new one when successful

 * Returns true if success, otherwise false

 * Return: true if success, otherwise false

 */

bool tipc_msg_reverse(u32 own_node,  struct sk_buff **skb, int err)

{
@@ -705,7 +706,7 @@ bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy) 
 * @skb: the buffer containing the message.

 * @err: error code to be used by caller if lookup fails

 * Does not consume buffer

 * Returns true if a destination is found, false otherwise

 * Return: true if a destination is found, false otherwise

 */

bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err)

{