code review 173300043: x/net/ipv4: update package documentation

x/net/ipv4: update package documentation

[mikio, 2014-11-19 10:38:01]

Hello iant@golang.org (cc: golang-codereviews@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go.net

[iant, 2014-11-19 21:03:10]

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go
File ipv4/dgramopt_stub.go (right):

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:47: // JoinGroup joins the group address group on the
interface ifi. By
s/group address group/group address grp/

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:52: // It uses the system assigned multicast interface
when ifi is nil,
s/It uses/JoinGroup uses/

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:59: // LeaveGroup leaves the group address group on the
interface ifi.
s/group address group/group address grp/

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:60: // It's allowed to leave the group which is formed by
I don't quite see the purpose of this last sentence.

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:66: // JoinSourceSpecificGroup joins the source-specific
group consisting
s/consisting/comprising/

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:81: // ExcludeSourceSpecificGroup excludes the
source-specific group from
I think some doc should make clear the different between
LeaveSourceSpecificGroup and ExcludeSourceSpecificGroup.  Right now it does not
seem clear to me.

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go
File ipv4/doc.go (right):

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go#newcode197
ipv4/doc.go:197: // And then an application that uses PacketConn or RawConn on
IGMPv3
s/And then an/An/

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go#newcode198
ipv4/doc.go:198: // supported platform is able to join soruce-specific multicast
groups
s/soruce/source/

[mikio, 2014-11-20 05:36:57]

ptal

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go
File ipv4/dgramopt_stub.go (right):

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:47: // JoinGroup joins the group address group on the
interface ifi. By
On 2014/11/19 21:03:10, iant wrote:
> s/group address group/group address grp/

Done.

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:52: // It uses the system assigned multicast interface
when ifi is nil,
On 2014/11/19 21:03:10, iant wrote:
> s/It uses/JoinGroup uses/

Done.

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:59: // LeaveGroup leaves the group address group on the
interface ifi.
On 2014/11/19 21:03:10, iant wrote:
> s/group address group/group address grp/

Done.

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:60: // It's allowed to leave the group which is formed by
On 2014/11/19 21:03:10, iant wrote:
> I don't quite see the purpose of this last sentence.

revised

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:66: // JoinSourceSpecificGroup joins the source-specific
group consisting
On 2014/11/19 21:03:10, iant wrote:
> s/consisting/comprising/

Done.

https://codereview.appspot.com/173300043/diff/140001/ipv4/dgramopt_stub.go#ne...
ipv4/dgramopt_stub.go:81: // ExcludeSourceSpecificGroup excludes the
source-specific group from
On 2014/11/19 21:03:10, iant wrote:
> I think some doc should make clear the different between
> LeaveSourceSpecificGroup and ExcludeSourceSpecificGroup.  Right now it does
not
> seem clear to me.

oh, "or JoinSourceSpecificGroup" is wrong. fixed and added some to doc.go

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go
File ipv4/doc.go (right):

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go#newcode197
ipv4/doc.go:197: // And then an application that uses PacketConn or RawConn on
IGMPv3
On 2014/11/19 21:03:10, iant wrote:
> s/And then an/An/

Done.

https://codereview.appspot.com/173300043/diff/140001/ipv4/doc.go#newcode198
ipv4/doc.go:198: // supported platform is able to join soruce-specific multicast
groups
On 2014/11/19 21:03:10, iant wrote:
> s/soruce/source/

Done.

[iant, 2014-11-21 17:48:33]

LGTM

[mikio, 2014-11-22 02:21:55]

*** Submitted as
https://code.google.com/p/go/source/detail?r=355f337d9458&repo=net ***

x/net/ipv4: update package documentation

LGTM=iant
R=iant
CC=golang-codereviews
https://codereview.appspot.com/173300043