Commit 85806af0 authored by Randy Dunlap's avatar Randy Dunlap Committed by David S. Miller
Browse files

net: fix kernel-doc warnings for socket.c 



Fix kernel-doc warnings by moving the kernel-doc notation to be
immediately above the functions that it describes.

Fixes these warnings for sock_sendmsg() and sock_recvmsg():

../net/socket.c:658: warning: Excess function parameter 'sock' description in 'INDIRECT_CALLABLE_DECLARE'
../net/socket.c:658: warning: Excess function parameter 'msg' description in 'INDIRECT_CALLABLE_DECLARE'
../net/socket.c:889: warning: Excess function parameter 'sock' description in 'INDIRECT_CALLABLE_DECLARE'
../net/socket.c:889: warning: Excess function parameter 'msg' description in 'INDIRECT_CALLABLE_DECLARE'
../net/socket.c:889: warning: Excess function parameter 'flags' description in 'INDIRECT_CALLABLE_DECLARE'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent ea9a0379

net/socket.c

+17 −17
Original line number Diff line number Diff line
@@ -645,14 +645,6 @@ void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags) 
}

EXPORT_SYMBOL(__sock_tx_timestamp);



/**

 *	sock_sendmsg - send a message through @sock

 *	@sock: socket

 *	@msg: message to send

 *

 *	Sends @msg through @sock, passing through LSM.

 *	Returns the number of bytes sent, or an error code.

 */

INDIRECT_CALLABLE_DECLARE(int inet_sendmsg(struct socket *, struct msghdr *,

					   size_t));

static inline int sock_sendmsg_nosec(struct socket *sock, struct msghdr *msg)
@@ -663,6 +655,14 @@ static inline int sock_sendmsg_nosec(struct socket *sock, struct msghdr *msg) 
	return ret;

}



/**

 *	sock_sendmsg - send a message through @sock

 *	@sock: socket

 *	@msg: message to send

 *

 *	Sends @msg through @sock, passing through LSM.

 *	Returns the number of bytes sent, or an error code.

 */

int sock_sendmsg(struct socket *sock, struct msghdr *msg)

{

	int err = security_socket_sendmsg(sock, msg,
@@ -875,15 +875,6 @@ void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk, 
}

EXPORT_SYMBOL_GPL(__sock_recv_ts_and_drops);



/**

 *	sock_recvmsg - receive a message from @sock

 *	@sock: socket

 *	@msg: message to receive

 *	@flags: message flags

 *

 *	Receives @msg from @sock, passing through LSM. Returns the total number

 *	of bytes received, or an error.

 */

INDIRECT_CALLABLE_DECLARE(int inet_recvmsg(struct socket *, struct msghdr *,

					   size_t , int ));

static inline int sock_recvmsg_nosec(struct socket *sock, struct msghdr *msg,
@@ -893,6 +884,15 @@ static inline int sock_recvmsg_nosec(struct socket *sock, struct msghdr *msg, 
				   msg_data_left(msg), flags);

}



/**

 *	sock_recvmsg - receive a message from @sock

 *	@sock: socket

 *	@msg: message to receive

 *	@flags: message flags

 *

 *	Receives @msg from @sock, passing through LSM. Returns the total number

 *	of bytes received, or an error.

 */

int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags)

{

	int err = security_socket_recvmsg(sock, msg, msg_data_left(msg), flags);

CRA Git | Maintained and supported by SUSTech CRA and CCSE