]> git.baikalelectronics.ru Git - kernel.git/commitdiff
net: fix documentation for kernel_getsockname
authorAlex Maydanik <alexander.maydanik@gmail.com>
Sat, 12 Feb 2022 10:29:27 +0000 (12:29 +0200)
committerDavid S. Miller <davem@davemloft.net>
Mon, 14 Feb 2022 14:01:19 +0000 (14:01 +0000)
Fixes return value documentation of kernel_getsockname()
and kernel_getpeername() functions.

The previous documentation wrongly specified that the return
value is 0 in case of success, however sock->ops->getname returns
the length of the address in bytes in case of success.

Signed-off-by: Alex Maydanik <alexander.maydanik@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
net/socket.c

index 50cf75730fd7be14d4e7bf37bc9586365790925f..982eecad464c6ee2b182b23a4c85a3f80a9f9508 100644 (file)
@@ -3448,7 +3448,7 @@ EXPORT_SYMBOL(kernel_connect);
  *     @addr: address holder
  *
  *     Fills the @addr pointer with the address which the socket is bound.
- *     Returns 0 or an error code.
+ *     Returns the length of the address in bytes or an error code.
  */
 
 int kernel_getsockname(struct socket *sock, struct sockaddr *addr)
@@ -3463,7 +3463,7 @@ EXPORT_SYMBOL(kernel_getsockname);
  *     @addr: address holder
  *
  *     Fills the @addr pointer with the address which the socket is connected.
- *     Returns 0 or an error code.
+ *     Returns the length of the address in bytes or an error code.
  */
 
 int kernel_getpeername(struct socket *sock, struct sockaddr *addr)