Paths

Table of Contentst

Differential D35890

ip6(4): document IP_ORIGDSTADDR
ClosedPublic
Actions

Authored by asomers on Jul 24 2022, 3:08 PM.

Tags

None

Referenced Files

	Unknown Object (File)
	Sun, Mar 31, 1:40 PM

	Unknown Object (File)
	Dec 22 2023, 11:41 PM

	Unknown Object (File)
	Dec 12 2023, 6:06 AM

	Unknown Object (File)
	Dec 9 2023, 8:02 AM

	Unknown Object (File)
	Dec 7 2023, 8:04 AM

	Unknown Object (File)
	Nov 29 2023, 12:54 AM

	Unknown Object (File)
	Nov 25 2023, 3:39 PM

	Unknown Object (File)
	Nov 8 2023, 1:21 PM

View All 25 Files

Subscribers

pauamma_gundo.com

Details

Reviewers

karels
eri
pauamma_gundo.com

Group Reviewers

Commits

rGbaa6a68cbe47: ip6(4): document IP_ORIGDSTADDR
rGe1d8b0f49a9e: ip6(4): document IP_ORIGDSTADDR
rGa043594c211f: ip6(4): document IP_ORIGDSTADDR

Summary

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

MFC after: 1 week

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

asomers created this revision.Jul 24 2022, 3:08 PM

Herald added a reviewer: manpages. · View Herald TranscriptJul 24 2022, 3:08 PM

Herald added a subscriber: imp. · View Herald Transcript

asomers requested review of this revision.Jul 24 2022, 3:08 PM

Harbormaster completed remote builds in B46522: Diff 108452.Jul 24 2022, 3:08 PM

pauamma_gundo.com requested changes to this revision.Jul 26 2022, 7:15 PM

pauamma_gundo.com added a subscriber: pauamma_gundo.com.

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

karels added inline comments.Jul 26 2022, 8:52 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).

asomers added inline comments.Jul 26 2022, 8:56 PM

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.

karels added inline comments.Jul 26 2022, 9:25 PM

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

Harbormaster completed remote builds in B46618: Diff 108581.Jul 26 2022, 9:58 PM

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

pauamma_gundo.com added inline comments.Jul 27 2022, 6:41 PM

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.)

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

Closed by commit rGa043594c211f: ip6(4): document IP_ORIGDSTADDR (authored by asomers). · Explain Why

This revision was automatically updated to reflect the committed changes.

asomers added a commit: rGa043594c211f: ip6(4): document IP_ORIGDSTADDR.

asomers added a commit: rGe1d8b0f49a9e: ip6(4): document IP_ORIGDSTADDR.Aug 20 2022, 3:00 AM

asomers added a commit: rGbaa6a68cbe47: ip6(4): document IP_ORIGDSTADDR.Aug 20 2022, 3:08 AM

Revision Contents
Changeset List

Path

Size

share/

man/

man4/

18 lines

Diff 108704

share/man/man4/ip6.4

Loading...