net/core: Document reuseport_add_sock() bind_inany argument
authorBart Van Assche <bvanassche@acm.org>
Mon, 25 Mar 2019 16:17:19 +0000 (09:17 -0700)
committerDavid S. Miller <davem@davemloft.net>
Wed, 27 Mar 2019 20:49:43 +0000 (13:49 -0700)
This patch avoids that the following warning is reported when building
with W=1:

warning: Function parameter or member 'bind_inany' not described in 'reuseport_add_sock'

Cc: Martin KaFai Lau <kafai@fb.com>
Fixes: 2dbb9b9e6df6 ("bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT") # v4.19.
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
net/core/sock_reuseport.c

index d8fe3e549373d92524561728f375b2ce73bf0db7..dc4aefdf2a084b0ec46cc14415dcfda00a9aaa3d 100644 (file)
@@ -144,6 +144,8 @@ static void reuseport_free_rcu(struct rcu_head *head)
  *  reuseport_add_sock - Add a socket to the reuseport group of another.
  *  @sk:  New socket to add to the group.
  *  @sk2: Socket belonging to the existing reuseport group.
+ *  @bind_inany: Whether or not the group is bound to a local INANY address.
+ *
  *  May return ENOMEM and not add socket to group under memory pressure.
  */
 int reuseport_add_sock(struct sock *sk, struct sock *sk2, bool bind_inany)