Page MenuHomeFreeBSD
Differential D5667

Document in ifconfig(8) that gre(4) also accepts tunnel commands
ClosedPublic
Actions

Authored by feld on Mar 17 2016, 7:13 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Apr 20, 2:35 PM
Unknown Object (File)
Sat, Apr 20, 1:33 PM
Unknown Object (File)
Sun, Apr 14, 4:32 AM
Unknown Object (File)
Sun, Apr 14, 4:04 AM
Unknown Object (File)
Mar 17 2024, 4:00 PM
Unknown Object (File)
Mar 17 2024, 3:32 PM
Unknown Object (File)
Mar 11 2024, 9:38 AM
Unknown Object (File)
Mar 4 2024, 11:40 PM
View All 75 Files
Subscribers
imp

Details

Reviewers
wblock
Group Reviewers
manpages
Commits
rS317593: Document in ifconfig(8) that gre(4) accepts tunnel commands
Summary

ifconfig(8) fails to mention that gre(4) also accepts tunnel commands

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

feld updated this revision to Diff 14403.Mar 17 2016, 7:13 PM
feld retitled this revision from to Document in ifconfig(8) that gre(4) also accepts tunnel commands.
feld updated this object.
feld edited the test plan for this revision. (Show Details)
feld added a reviewer: wblock.
Herald added a reviewer: manpages. · View Herald TranscriptMar 17 2016, 7:13 PM
Herald added a subscriber: imp. · View Herald Transcript
feld updated this revision to Diff 14405.Mar 17 2016, 7:19 PM
feld edited edge metadata.

Try to remove the "specific to" wording which is misleading

Herald edited edge metadata. · View Herald TranscriptMar 17 2016, 7:19 PM
feld updated this revision to Diff 14406.Mar 17 2016, 7:21 PM
feld edited edge metadata.

"IP tunnel" -> "GRE tunnel" in the GRE section

Herald edited edge metadata. · View Herald TranscriptMar 17 2016, 7:21 PM
feld updated this revision to Diff 14407.Mar 17 2016, 7:25 PM
feld edited edge metadata.

"available for" is ... bad wording. I like "applicable to" much better.

Herald edited edge metadata. · View Herald TranscriptMar 17 2016, 7:25 PM
wblock added inline comments.Mar 17 2016, 7:26 PM
sbin/ifconfig/ifconfig.8
2420 ↗(On Diff #14406)

"The following" is almost always used wrongly, so replace with "These".
Also, this sentence is weirdly worded, using "interfaces" but only listing one. I'd guess that previous edits removed others.
So maybe:

These parameters are available for the
.Xr gif 4
IP tunnel interface:
2470 ↗(On Diff #14406)

As above:

These parameters are available for the
.Xr gre 4
tunnel interface:
wblock added inline comments.Mar 17 2016, 7:28 PM
sbin/ifconfig/ifconfig.8
2420 ↗(On Diff #14407)

"applicable to" is kind of roundabout wording. How about
s/are applicable to/apply to/

wblock mentioned this in D5668: ifconfig(8): tunnel keyword is also for gre.Mar 17 2016, 9:10 PM
feld updated this revision to Diff 23681.Jan 6 2017, 10:01 PM
feld edited edge metadata.

Change wording

Herald edited edge metadata. · View Herald TranscriptJan 6 2017, 10:01 PM
feld marked 3 inline comments as done.Jan 6 2017, 10:06 PM

I kept "The following parameters" because it's used about 20 times in this file. So unless we want to update the wording for every instance it seems out of place to change the pattern in these two places.

wblock accepted this revision.Jan 13 2017, 5:50 PM
wblock edited edge metadata.
In D5667#187435, @feld wrote:

I kept "The following parameters" because it's used about 20 times in this file. So unless we want to update the wording for every instance it seems out of place to change the pattern in these two places.

It's not correct just because it is used a lot. Think of fixing it not as being inconsistent, but correcting two instances of bad code. And it's not necessary to fix everything. Think of it like a hiking trail, leave it better than you found it. If everyone did that, there would be little to fix.

That said, it's not worth holding up this nearly year-old patch. Please check with mandoc -Tlint and igor -R before commit. Thanks!

This revision is now accepted and ready to land.Jan 13 2017, 5:50 PM
Closed by commit rS317593: Document in ifconfig(8) that gre(4) accepts tunnel commands (authored by feld). · Explain WhyApr 29 2017, 3:35 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
head/
sbin/
ifconfig/
23 lines

Diff 27849

View Options

head/sbin/ifconfig/ifconfig.8

Loading...