Page MenuHomeFreeBSD

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

Authored by feld on Mar 17 2016, 7:13 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Dec 19, 4:04 PM
Unknown Object (File)
Thu, Dec 19, 3:56 PM
Unknown Object (File)
Thu, Dec 19, 3:43 PM
Unknown Object (File)
Thu, Dec 19, 3:24 PM
Unknown Object (File)
Thu, Dec 19, 2:57 PM
Unknown Object (File)
Fri, Nov 29, 12:06 AM
Unknown Object (File)
Nov 20 2024, 10:59 PM
Unknown Object (File)
Nov 13 2024, 2:05 AM
Subscribers

Details

Summary

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

Diff Detail

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

Event Timeline

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.
feld edited edge metadata.

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

feld edited edge metadata.

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

feld edited edge metadata.

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

sbin/ifconfig/ifconfig.8
2420

"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

As above:

These parameters are available for the
.Xr gre 4
tunnel interface:
sbin/ifconfig/ifconfig.8
2420

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

feld edited edge metadata.

Change wording

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 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
This revision was automatically updated to reflect the committed changes.