[PATCH] net: fix documentation for kernel_getsockname

[PATCH] net: fix documentation for kernel_getsockname

[Alex Maydanik]

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>
---
 net/socket.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/net/socket.c b/net/socket.c
index 50cf75730fd7..982eecad464c 100644
--- a/net/socket.c
+++ b/net/socket.c
@@ -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)
-- 
2.25.1

Re: [PATCH] net: fix documentation for kernel_getsockname

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (master)
by David S. Miller <davem@davemloft.net>:

On Sat, 12 Feb 2022 12:29:27 +0200 you wrote:
> 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.
> 
> [...]

Here is the summary with links:
  - net: fix documentation for kernel_getsockname
    https://git.kernel.org/netdev/net/c/0fc95dec096c

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Re: net: fix documentation for kernel_getsockname: Build Failure

[MPTCP CI]

Hi Alex,

Thank you for your modifications, that's great!

But sadly, our CI spotted some issues with it when trying to build it.

You can find more details there:

  https://patchwork.kernel.org/project/mptcp/patch/20220212102927.25436-1-alexander.maydanik@gmail.com/
  https://github.com/multipath-tcp/mptcp_net-next/actions/runs/1843188936

Status: failure
Initiator: MPTCPimporter
Commits: https://github.com/multipath-tcp/mptcp_net-next/commits/ec18713d1f5d

Feel free to reply to this email if you cannot access logs, if you need
some support to fix the error, if this doesn't seem to be caused by your
modifications or if the error is a false positive one.

Cheers,
MPTCP GH Action bot

Re: net: fix documentation for kernel_getsockname: Build Failure

[Mat Martineau]

On Mon, 14 Feb 2022, MPTCP CI wrote:

> Hi Alex,
>
> Thank you for your modifications, that's great!
>
> But sadly, our CI spotted some issues with it when trying to build it.
>
> You can find more details there:
>
>  https://patchwork.kernel.org/project/mptcp/patch/20220212102927.25436-1-alexander.maydanik@gmail.com/
>  https://github.com/multipath-tcp/mptcp_net-next/actions/runs/1843188936
>
> Status: failure
> Initiator: MPTCPimporter
> Commits: https://github.com/multipath-tcp/mptcp_net-next/commits/ec18713d1f5d
>

Alex,

Sorry about the unexpected email from our CI system. It appears there was
an issue with patchew.org that somehow applied and tagged your patch in
our github repo even though you didn't send to our mailing list.

--
Mat Martineau
Intel