ifconfig(8) fails to mention that gre(4) also accepts tunnel commands
Details
Details
- Reviewers
wblock - Group Reviewers
manpages - Commits
- rS317593: Document in ifconfig(8) that gre(4) accepts tunnel commands
Diff Detail
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
| sbin/ifconfig/ifconfig.8 | ||
|---|---|---|
| 2420 | "The following" is almost always used wrongly, so replace with "These". 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 | |
Comment Actions
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.
Comment Actions
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!