aboutsummaryrefslogtreecommitdiffstats
path: root/net/socket.c
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2019-05-19 00:23:07 -0400
committerDavid S. Miller <davem@davemloft.net>2019-05-19 13:33:22 -0400
commit85806af0c6bac0feb777e255a25fd5d0cf6ad38e (patch)
treec1fe118bdf69f9dd5f7f94e467555eb9968953b3 /net/socket.c
parentea9a03791a73e853897eda93e139018ca38f3c94 (diff)
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: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/socket.c')
-rw-r--r--net/socket.c34
1 files changed, 17 insertions, 17 deletions
diff --git a/net/socket.c b/net/socket.c
index 472fbefa5d9b..72372dc5dd70 100644
--- a/net/socket.c
+++ b/net/socket.c
@@ -645,14 +645,6 @@ void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags)
645} 645}
646EXPORT_SYMBOL(__sock_tx_timestamp); 646EXPORT_SYMBOL(__sock_tx_timestamp);
647 647
648/**
649 * sock_sendmsg - send a message through @sock
650 * @sock: socket
651 * @msg: message to send
652 *
653 * Sends @msg through @sock, passing through LSM.
654 * Returns the number of bytes sent, or an error code.
655 */
656INDIRECT_CALLABLE_DECLARE(int inet_sendmsg(struct socket *, struct msghdr *, 648INDIRECT_CALLABLE_DECLARE(int inet_sendmsg(struct socket *, struct msghdr *,
657 size_t)); 649 size_t));
658static inline int sock_sendmsg_nosec(struct socket *sock, struct msghdr *msg) 650static 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)
663 return ret; 655 return ret;
664} 656}
665 657
658/**
659 * sock_sendmsg - send a message through @sock
660 * @sock: socket
661 * @msg: message to send
662 *
663 * Sends @msg through @sock, passing through LSM.
664 * Returns the number of bytes sent, or an error code.
665 */
666int sock_sendmsg(struct socket *sock, struct msghdr *msg) 666int sock_sendmsg(struct socket *sock, struct msghdr *msg)
667{ 667{
668 int err = security_socket_sendmsg(sock, msg, 668 int err = security_socket_sendmsg(sock, msg,
@@ -875,15 +875,6 @@ void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
875} 875}
876EXPORT_SYMBOL_GPL(__sock_recv_ts_and_drops); 876EXPORT_SYMBOL_GPL(__sock_recv_ts_and_drops);
877 877
878/**
879 * sock_recvmsg - receive a message from @sock
880 * @sock: socket
881 * @msg: message to receive
882 * @flags: message flags
883 *
884 * Receives @msg from @sock, passing through LSM. Returns the total number
885 * of bytes received, or an error.
886 */
887INDIRECT_CALLABLE_DECLARE(int inet_recvmsg(struct socket *, struct msghdr *, 878INDIRECT_CALLABLE_DECLARE(int inet_recvmsg(struct socket *, struct msghdr *,
888 size_t , int )); 879 size_t , int ));
889static inline int sock_recvmsg_nosec(struct socket *sock, struct msghdr *msg, 880static 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,
893 msg_data_left(msg), flags); 884 msg_data_left(msg), flags);
894} 885}
895 886
887/**
888 * sock_recvmsg - receive a message from @sock
889 * @sock: socket
890 * @msg: message to receive
891 * @flags: message flags
892 *
893 * Receives @msg from @sock, passing through LSM. Returns the total number
894 * of bytes received, or an error.
895 */
896int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags) 896int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags)
897{ 897{
898 int err = security_socket_recvmsg(sock, msg, msg_data_left(msg), flags); 898 int err = security_socket_recvmsg(sock, msg, msg_data_left(msg), flags);