tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

net/iucv: Add missing kernel-doc return value descriptions

Add missing return value descriptions for several functions in
net/iucv/af_iucv.c and net/iucv/iucv.c to address kernel-doc warnings.

Warnings detected with:
scripts/kernel-doc -none -Wall net/iucv/*
Warning: net/iucv/af_iucv.c:131 No description found for return value of 'iucv_msg_length'
Warning: net/iucv/af_iucv.c:150 No description found for return value of 'iucv_sock_in_state'
...

No functional change.

Reviewed-by: Aswin Karuvally <aswin@linux.ibm.com>
Reviewed-by: Alexandra Winter <wintera@linux.ibm.com>
Signed-off-by: Nagamani PV <nagamani@linux.ibm.com>
Signed-off-by: Alexandra Winter <wintera@linux.ibm.com>
Link: https://patch.msgid.link/20260330114436.2010108-1-wintera@linux.ibm.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Nagamani PV and committed by
Jakub Kicinski f1359c24 58e416e2

+13 -5
+7 -5
net/iucv/af_iucv.c
··· 127 127 * if the socket data len is > 7, the function returns 8. 128 128 * 129 129 * Use this function to allocate socket buffers to store iucv message data. 130 + * 131 + * Returns: Length of the IUCV message. 130 132 */ 131 133 static inline size_t iucv_msg_length(struct iucv_message *msg) 132 134 { ··· 147 145 * @state: first iucv sk state 148 146 * @state2: second iucv sk state 149 147 * 150 - * Returns true if the socket in either in the first or second state. 148 + * Returns: true if the socket is either in the first or second state. 151 149 */ 152 150 static int iucv_sock_in_state(struct sock *sk, int state, int state2) 153 151 { ··· 158 156 * iucv_below_msglim() - function to check if messages can be sent 159 157 * @sk: sock structure 160 158 * 161 - * Returns true if the send queue length is lower than the message limit. 162 - * Always returns true if the socket is not connected (no iucv path for 163 - * checking the message limit). 159 + * Returns: true, if either the socket is not connected (no iucv path for 160 + * checking the message limit) or if the send queue length is lower 161 + * than the message limit. 164 162 */ 165 163 static inline int iucv_below_msglim(struct sock *sk) 166 164 { ··· 885 883 * list and the socket data len at index 7 (last byte). 886 884 * See also iucv_msg_length(). 887 885 * 888 - * Returns the error code from the iucv_message_send() call. 886 + * Returns: the return code from the iucv_message_send() call. 889 887 */ 890 888 static int iucv_send_iprm(struct iucv_path *path, struct iucv_message *msg, 891 889 struct sk_buff *skb)
+6
net/iucv/iucv.c
··· 687 687 * 688 688 * @pathid: path identification number. 689 689 * @userdata: 16-bytes of user data. 690 + * 691 + * Returns: 0 on success, the result of the CP b2f0 IUCV call. 690 692 */ 691 693 static int iucv_sever_pathid(u16 pathid, u8 *userdata) 692 694 { ··· 1094 1092 * 1095 1093 * Internal function used by iucv_message_receive and __iucv_message_receive 1096 1094 * to receive RMDATA data stored in struct iucv_message. 1095 + * 1096 + * Returns: 0 1097 1097 */ 1098 1098 static int iucv_message_receive_iprmdata(struct iucv_path *path, 1099 1099 struct iucv_message *msg, ··· 1856 1852 1857 1853 /** 1858 1854 * iucv_init - Allocates and initializes various data structures. 1855 + * 1856 + * Returns: 0 on success, return code on failure. 1859 1857 */ 1860 1858 static int __init iucv_init(void) 1861 1859 {