netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* Undocumented IPv6 options
@ 2007-10-15  6:54 Michael Kerrisk
  2007-10-15  7:39 ` Matti Aarnio
  0 siblings, 1 reply; 4+ messages in thread
From: Michael Kerrisk @ 2007-10-15  6:54 UTC (permalink / raw)
  To: netdev; +Cc: linux-man, Andrew McDonald, linux-net

Hello netdev,

Andrew McDonald kindly fixed the description of IPV6_ROUTER_ALERT in the
ipv7.7 man page.  As long as we're on the topic, I'll point out that the
following IPV6 options (and possibly others) are still not documented on
that page:

IPV6_CHECKSUM
IPV6_JOIN_ANYCAST
IPV6_LEAVE_ANYCAST
IPV6_V6ONLY
IPV6_RECVPKTINFO
IPV6_2292PKTINFO

Can anyone help with documenting any of these please?

Cheers,

Michael
-- 
Michael Kerrisk
maintainer of Linux man pages Sections 2, 3, 4, 5, and 7

Want to help with man page maintenance?  Grab the latest tarball at
http://www.kernel.org/pub/linux/docs/manpages/
read the HOWTOHELP file and grep the source files for 'FIXME'.



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Undocumented IPv6 options
  2007-10-15  6:54 Undocumented IPv6 options Michael Kerrisk
@ 2007-10-15  7:39 ` Matti Aarnio
  2007-10-15 11:45   ` Andi Kleen
  2007-10-15 21:03   ` Michael Kerrisk
  0 siblings, 2 replies; 4+ messages in thread
From: Matti Aarnio @ 2007-10-15  7:39 UTC (permalink / raw)
  To: Michael Kerrisk; +Cc: netdev, linux-man, Andrew McDonald, linux-net

On Mon, Oct 15, 2007 at 08:54:49AM +0200, Michael Kerrisk wrote:
> Hello netdev,
> 
> Andrew McDonald kindly fixed the description of IPV6_ROUTER_ALERT in the
> ipv7.7 man page.  As long as we're on the topic, I'll point out that the
> following IPV6 options (and possibly others) are still not documented on
> that page:
> 
> IPV6_CHECKSUM
> IPV6_JOIN_ANYCAST
> IPV6_LEAVE_ANYCAST
> IPV6_V6ONLY
> IPV6_RECVPKTINFO
> IPV6_2292PKTINFO
> 
> Can anyone help with documenting any of these please?

RFC 2553 was obsoleted by RFC 3493, and it added IPV6_V6ONLY into Basic API.

RFC 2292 (IPV6 Advanced API) defines IPV6_CHECKSUM, and IPV6_PKTINFO
(latter of which is known above as IPV6_2292PKTINFO)

RFC 3542 obsoletes RFC 2292, and defines IPV6_RECVPKTINFO, and
modifies IPV6_PKTINFO.

The  IPV6_JOIN_ANYCAST  and  IPV6_LEAVE_ANYCAST  are not defined in any RFC.

Undocumented are also IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP (RFC 2553 / 3493)


It really looks like time for major overhaul of that (and related) man-pages
is needed...

> Cheers,
> 
> Michael
> -- 
> Michael Kerrisk
> maintainer of Linux man pages Sections 2, 3, 4, 5, and 7

/Matti Aarnio

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Undocumented IPv6 options
  2007-10-15  7:39 ` Matti Aarnio
@ 2007-10-15 11:45   ` Andi Kleen
  2007-10-15 21:03   ` Michael Kerrisk
  1 sibling, 0 replies; 4+ messages in thread
From: Andi Kleen @ 2007-10-15 11:45 UTC (permalink / raw)
  To: Matti Aarnio
  Cc: Michael Kerrisk, netdev, linux-man, Andrew McDonald, linux-net

Matti Aarnio <matti.aarnio@zmailer.org> writes:
>
> Undocumented are also IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP (RFC 2553 / 3493)

The IPv6 man page was never complete when I wrote it long ago.

This 

BUGS
        ...
        This man page is not complete.

is still true.

> It really looks like time for major overhaul of that (and related) man-pages
> is needed...

IPv6 just needs finishing.

One option actually since the RFCs document IPv6 basic and extended
API very well would be to somehow pull them in similar to the POSIX
manpages and let them speak for themselves.

I don't know if that is possible with the RFC copyrights though (?)

-Andi

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Undocumented IPv6 options
  2007-10-15  7:39 ` Matti Aarnio
  2007-10-15 11:45   ` Andi Kleen
@ 2007-10-15 21:03   ` Michael Kerrisk
  1 sibling, 0 replies; 4+ messages in thread
From: Michael Kerrisk @ 2007-10-15 21:03 UTC (permalink / raw)
  To: Matti Aarnio; +Cc: netdev, linux-man, Andrew McDonald, linux-net, andi

> It really looks like time for major overhaul of that (and related) man-pages
> is needed...

Yes.  Andi Kleen did a good job of putting some pages together in
the 2.2 timeframe, but no-one else carried on the work since then,
and there is much that sould be updated in the *.7 networking
pages.

Cheers,

Michael

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2007-10-15 21:03 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-10-15  6:54 Undocumented IPv6 options Michael Kerrisk
2007-10-15  7:39 ` Matti Aarnio
2007-10-15 11:45   ` Andi Kleen
2007-10-15 21:03   ` Michael Kerrisk

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).