bybrooklyn/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-04-18 06:44:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Nagamani PV
2026-03-30 13:44:36 +02:00
committed by Jakub Kicinski
parent 58e416e283
commit f1359c2401
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
net/iucv/af_iucv.c
View File

@@ -127,6 +127,8 @@ static inline void low_nmcpy(unsigned char *dst, char *src)
* if the socket data len is > 7, the function returns 8.
*
* Use this function to allocate socket buffers to store iucv message data.
*
* Returns: Length of the IUCV message.
*/
static inline size_t iucv_msg_length(struct iucv_message *msg)
{
@@ -145,7 +147,7 @@ static inline size_t iucv_msg_length(struct iucv_message *msg)
* @state: first iucv sk state
* @state2: second iucv sk state
*
* Returns true if the socket in either in the first or second state.
* Returns: true if the socket is either in the first or second state.
*/
static int iucv_sock_in_state(struct sock *sk, int state, int state2)
{
@@ -156,9 +158,9 @@ static int iucv_sock_in_state(struct sock *sk, int state, int state2)
* iucv_below_msglim() - function to check if messages can be sent
* @sk: sock structure
*
* Returns true if the send queue length is lower than the message limit.
* Always returns true if the socket is not connected (no iucv path for
* checking the message limit).
* Returns: true, if either the socket is not connected (no iucv path for
* checking the message limit) or if the send queue length is lower
* than the message limit.
*/
static inline int iucv_below_msglim(struct sock *sk)
{
@@ -883,7 +885,7 @@ static int iucv_sock_getname(struct socket *sock, struct sockaddr *addr,
* list and the socket data len at index 7 (last byte).
* See also iucv_msg_length().
*
* Returns the error code from the iucv_message_send() call.
* Returns: the return code from the iucv_message_send() call.
*/
static int iucv_send_iprm(struct iucv_path *path, struct iucv_message *msg,
struct sk_buff *skb)

6
net/iucv/iucv.c
View File

@@ -687,6 +687,8 @@ __free_cpumask:
*
* @pathid: path identification number.
* @userdata: 16-bytes of user data.
*
* Returns: 0 on success, the result of the CP b2f0 IUCV call.
*/
static int iucv_sever_pathid(u16 pathid, u8 *userdata)
{
@@ -1092,6 +1094,8 @@ EXPORT_SYMBOL(iucv_message_purge);
*
* Internal function used by iucv_message_receive and __iucv_message_receive
* to receive RMDATA data stored in struct iucv_message.
*
* Returns: 0
*/
static int iucv_message_receive_iprmdata(struct iucv_path *path,
struct iucv_message *msg,
@@ -1852,6 +1856,8 @@ static enum cpuhp_state iucv_online;
/**
* iucv_init - Allocates and initializes various data structures.
*
* Returns: 0 on success, return code on failure.
*/
static int __init iucv_init(void)
{