[PATCH net-next] Fix inaccurate helper function description

[PATCH net-next] Fix inaccurate helper function description

[Chenbo Feng]

From: Chenbo Feng <fengc@google.com>

The description inside uapi/linux/bpf.h about bpf_get_socket_uid
helper function is no longer valid. It returns overflowuid rather
than 0 when failed.

Signed-off-by: Chenbo Feng <fengc@google.com>
---
 include/uapi/linux/bpf.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index e553529..945a1f5 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -481,8 +481,7 @@ union bpf_attr {
  * u32 bpf_get_socket_uid(skb)
  *     Get the owner uid of the socket stored inside sk_buff.
  *     @skb: pointer to skb
- *     Return: uid of the socket owner on success or 0 if the socket pointer
- *     inside sk_buff is NULL
+ *     Return: uid of the socket owner on success or overflowuid if failed.
  */
 #define __BPF_FUNC_MAPPER(FN)		\
 	FN(unspec),			\
-- 
2.7.4

Re: [PATCH net-next] Fix inaccurate helper function description

[Daniel Borkmann]

On 04/27/2017 01:41 AM, Chenbo Feng wrote:
> From: Chenbo Feng <fengc@google.com>
>
> The description inside uapi/linux/bpf.h about bpf_get_socket_uid
> helper function is no longer valid. It returns overflowuid rather
> than 0 when failed.
>
> Signed-off-by: Chenbo Feng <fengc@google.com>

"bpf: " prefix in patch subject line would have been good.

Acked-by: Daniel Borkmann <daniel@iogearbox.net>

Re: [PATCH net-next] Fix inaccurate helper function description

[Alexei Starovoitov]

On Thu, Apr 27, 2017 at 01:10:27PM +0200, Daniel Borkmann wrote:
> On 04/27/2017 01:41 AM, Chenbo Feng wrote:
> > From: Chenbo Feng <fengc@google.com>
> > 
> > The description inside uapi/linux/bpf.h about bpf_get_socket_uid
> > helper function is no longer valid. It returns overflowuid rather
> > than 0 when failed.
> > 
> > Signed-off-by: Chenbo Feng <fengc@google.com>
> 
> "bpf: " prefix in patch subject line would have been good.

+1

last time missing 'bpf:' prefix caused me headaches during backporting,
so please always use it.
Also please use scripts/get_maintainer.pl to make sure
maintainers cc-ed on patches.
gmail delivers netdev list emails to my mailbox with 10+ hour delay
for some reason.

Acked-by: Alexei Starovoitov <ast@kernel.org>

Re: [PATCH net-next] Fix inaccurate helper function description

[David Miller]

From: Chenbo Feng <chenbofeng.kernel@gmail.com>
Date: Wed, 26 Apr 2017 16:41:23 -0700

> From: Chenbo Feng <fengc@google.com>
> 
> The description inside uapi/linux/bpf.h about bpf_get_socket_uid
> helper function is no longer valid. It returns overflowuid rather
> than 0 when failed.
> 
> Signed-off-by: Chenbo Feng <fengc@google.com>

Applied.