+ tag SPDX + align lists + fix one sentance per line warning
+ alphabetize options + add a line break to examples
+ organize exits, and provide error numbers
Reported by: Antranig Vartanian <antranigv@freebsd.am>
MFC after: 3 days
Details
Details
- Reviewers
carlavilla mhorne - Group Reviewers
manpages
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Skipped - Unit
Tests Skipped - Build Status
Buildable 61919 Build 58803: arc lint + arc unit
Event Timeline
Comment Actions
Revert s/Dv/Sy/g, I did that to align with sysexits(3), however this was
a mistake as I think apropos Dv=EX_USAGE is an outstanding workflow. I
now believe that error messages should always be Dv.
Comment Actions
Use Er to markup error constants according to mdoc(7), and use
Dv to markup the exit numbers to enable apropos Dv=64.
| usr.bin/lockf/lockf.1 | ||
|---|---|---|
| 171 | Okay, now I see where you were coming from with D48619... It seems clear to me that apropos Er=EX_USAGE should lead to this page. But I am not sure that apropos Dv=64 needs to. If the status code I am investigating comes from lockf(1), then I surely know which man page to check, no? | |
| 185–186 | .Po/.Pc save some headaches here. | |
Comment Actions
Honestly, IMHO what would be best is Er=$actual_returned_number, but mandoc isn't written that way. The workflow for Er is actually purely imagined for me at this point since it doesn't exist yet for anything I've checked, which is normally completely unacceptable, but my rationale is that confirming to the standard will create allowance for the workflow.
One idea for Dv contributed by kevans@ is debugging complex shell scripts with $?, which I think would be reinforcing design consistency.