Page MenuHomeFreeBSD

ip6(4): document IP_ORIGDSTADDR
ClosedPublic

Authored by asomers on Jul 24 2022, 3:08 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Oct 27, 5:59 AM
Unknown Object (File)
Sat, Oct 19, 7:42 AM
Unknown Object (File)
Oct 4 2024, 5:07 AM
Unknown Object (File)
Oct 3 2024, 10:04 PM
Unknown Object (File)
Sep 24 2024, 3:34 AM
Unknown Object (File)
Sep 23 2024, 10:12 PM
Unknown Object (File)
Sep 17 2024, 2:41 PM
Unknown Object (File)
Sep 6 2024, 9:54 PM

Details

Summary

The option was originally added in r313524, but with incomplete
documentation.

MFC after: 1 week

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 46522
Build 43411: arc lint + arc unit

Event Timeline

pauamma_gundo.com added inline comments.
share/man/man4/ip6.4
234–251

That part should be in recvmsg(2), not here.

This revision now requires changes to proceed.Jul 26 2022, 7:15 PM
share/man/man4/ip6.4
234–251

Which part? It all seems specific to IPv6. It is more detailed than other descriptions of ancillary data, which may not be completely necessary. Other options enabling ancillary data don't specify these details about the cmsghdr, they just name the structure returned. Other details are given in a paragraph below this list for the other such options; this should be added to the list there (search for IPV6_PKTINFO).

share/man/man4/ip6.4
234–251

I modeled it after the description of IP_ORIGDSTADDR in ip(4), which has more detailed descriptions than ip(6). IMHO ip(4) is the better man page.

share/man/man4/ip6.4
234–251

I see. I see elements to like in both. It is unfortunate that they differ so much. I'm not sure what to suggest other than that someone make them consistent, taking the best of each. I do think that IPV6_ORIGDSTADDR should be listed with the other such options in the paragraph I mentioned. It would be nice to reduce the duplication in ip(4) with a similar paragraph (perhaps with a little more detail).

In any case, I don't think the new text belongs in recvmsg(2), which should be generic.

  • Reduce duplication as suggested by @karels

I am fine with this version. Presumably manpages must still approve.

share/man/man4/ip6.4
234–251

Which part?

I mean the part (which I distinctly remember highlighting from start to end before commenting - did I or Phabricator mess that up?) that explains where in the information returned by recvmsg the source address is stored. If I were using recvmsg, I would look for that info in recvmsg(2), not here.

(But I see now that the IPV6_PKTINFO description below does the same, so perhaps this is a more general discussion than belongs in this review.)

gbe added a subscriber: gbe.

LGTM. These are critical information, the man page syntax is correct and will land in -CURRENT. Documentation is essential.

This revision was not accepted when it landed; it landed in state Needs Review.Jul 29 2022, 3:09 PM
This revision was automatically updated to reflect the committed changes.