man page update (ip.7) to reflect new socket option in 2.6.31
diff mbox

Message ID 4A3B3C92.9050003@us.ibm.com
State Not Applicable, archived
Delegated to: David Miller
Headers show

Commit Message

Nivedita Singhvi June 19, 2009, 7:21 a.m. UTC
Nivedita Singhvi wrote:
> This patch adds the IP_MULTICAST_ALL option to
> the ip.7 man page, to bring it up to date with
> 2.6.31 development.

Ah, the "since" is intended to be inclusive. The
2.6.30 needs to be 2.6.31. Correct version below.
Apologies!

Signed-off-by: Nivedita Singhvi <niv@us.ibm.com>

---
  man7/ip.7 |   10 +++++++++-
  1 files changed, 9 insertions(+), 1 deletions(-)

--

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Michael Kerrisk July 25, 2009, 4:43 a.m. UTC | #1
Hello Nivedita

On Fri, Jun 19, 2009 at 9:21 AM, Nivedita Singhvi<niv@us.ibm.com> wrote:
> Nivedita Singhvi wrote:
>>
>> This patch adds the IP_MULTICAST_ALL option to
>> the ip.7 man page, to bring it up to date with
>> 2.6.31 development.
>
> Ah, the "since" is intended to be inclusive.

Yep ;-).

> The
> 2.6.30 needs to be 2.6.31. Correct version below.
> Apologies!

No worries. Glad you caught it. Some belated comments below.

> Signed-off-by: Nivedita Singhvi <niv@us.ibm.com>
>
> ---
>  man7/ip.7 |   10 +++++++++-
>  1 files changed, 9 insertions(+), 1 deletions(-)
>
> diff --git a/man7/ip.7 b/man7/ip.7
> index ab866a1..6932ba2 100644
> --- a/man7/ip.7
> +++ b/man7/ip.7
> @@ -357,7 +357,6 @@ and retrieve the MTU by calling
>  with the
>  .B IP_MTU
>  option.
> -
>  It is possible to implement RFC 4821 MTU probing with
>  .B SOCK_DGRAM
>  or
> @@ -383,6 +382,15 @@ When an invalid socket option is passed,
>  .B ENOPROTOOPT
>  is returned.
>  .TP
> +.BR IP_MULTICAST_ALL " (since Linux 2.6.31)"
> +Sets the multicast delivery policy to the socket.  Argument is a boolean

Is the following better here:
Sets the policy for multicast delivery to the socket
?

> +integer that enables or disables multicast delivery from all groups.
> +If not set, delivery to the socket is restricted to data from those
> multicast
> +groups that have been explicitly subscribed to via a multicast join
> operation
> +for this socket. The default is 1 which means that a socket which is bound
> +to the wildcard address (INADDR_ANY) will receive multicast packets from
> all
> +groups that have been subscribed to on this system.
> +.TP
>  .BR IP_MULTICAST_LOOP " (since Linux 1.2)"

Cheers,

Michael

Patch
diff mbox

diff --git a/man7/ip.7 b/man7/ip.7
index ab866a1..6932ba2 100644
--- a/man7/ip.7
+++ b/man7/ip.7
@@ -357,7 +357,6 @@  and retrieve the MTU by calling
  with the
  .B IP_MTU
  option.
-
  It is possible to implement RFC 4821 MTU probing with
  .B SOCK_DGRAM
  or
@@ -383,6 +382,15 @@  When an invalid socket option is passed,
  .B ENOPROTOOPT
  is returned.
  .TP
+.BR IP_MULTICAST_ALL " (since Linux 2.6.31)"
+Sets the multicast delivery policy to the socket.  Argument is a boolean
+integer that enables or disables multicast delivery from all groups.
+If not set, delivery to the socket is restricted to data from those multicast
+groups that have been explicitly subscribed to via a multicast join operation
+for this socket. The default is 1 which means that a socket which is bound
+to the wildcard address (INADDR_ANY) will receive multicast packets from all
+groups that have been subscribed to on this system.
+.TP
  .BR IP_MULTICAST_LOOP " (since Linux 1.2)"
  Sets or reads a boolean integer argument that determines whether
  sent multicast packets should be looped back to the local sockets.