For consistency, create a symbolic link from mgb.4 to also
if_mgb.4
Details
Details
- Reviewers
ziaee emaste - Group Reviewers
manpages - Commits
- rG2d935a1e93af: man.4: Create if_mgb.4 symlink on supported architectures only.
rG05c49e2aa643: man: Link mgb.4 to if_mgb.4
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 77970 Build 74853: arc lint + arc unit
Event Timeline
Comment Actions
If mgb.4 only works on x86, the way to specify that in the manual is to add it to line 25 of mgb.4, like this:
.Dt MGB 4 amd64
| share/man/man4/Makefile | ||
|---|---|---|
| 799–800 | I think you'd actually leave it here, and do it like this, this seems like how the others are done, e.g. bxe.4 | |
| 957 | (except sorted and tabbed and everything) | |
Comment Actions
The commit is correct. Documentation needs to match what is actually going on, not what could go on with a trivial rewrite.
However, please please please, if I help you with a commit, use the Discussed with: trailer in accordance with project policy. Because I have to explain what I did each month to pay my bills, but there is too much for me to review/hours I can bill that I do not have time to make a log, I have to just scrape the commit log.
Comment Actions
Documentation needs to match what is actually going on, not what could go on with a trivial rewrite.
Yes, of course. Sometimes though it is easier and less work to fix the misbehaviour than to document it -- D60615, which reverts e0a5aa37c1ef3a22e2dc8c311e0e32ea363f7ccf and 2d935a1e93af4d552db1f7218ef97e01f058c084.