Page MenuHomeFreeBSD

sysexits.3: Enable apropos by error number
Needs ReviewPublic

Authored by ziaee on Jan 23 2025, 1:51 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Sep 27, 5:02 PM
Unknown Object (File)
Sat, Sep 27, 2:46 PM
Unknown Object (File)
Thu, Sep 25, 9:51 AM
Unknown Object (File)
Sun, Sep 21, 4:08 AM
Unknown Object (File)
Mon, Sep 15, 9:46 PM
Unknown Object (File)
Sep 14 2025, 10:31 AM
Unknown Object (File)
Sep 12 2025, 7:26 PM
Unknown Object (File)
Sep 6 2025, 5:48 PM
Subscribers

Details

Reviewers
carlavilla
mhorne
Group Reviewers
manpages
Summary

Markup exit status codes as defined variables. This produces no change
in rendered output, however enables this workflow:

$ apropos Dv=67
sysexits(3) - legacy exit status codes for system programs

MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 61914
Build 58798: arc lint + arc unit

Event Timeline

ziaee requested review of this revision.Jan 23 2025, 1:51 PM

We can quickly enter bikeshed territory debating something like this, but I must ask, is this workflow real or imagined?

It is somewhat of a stretch to declare numeric literals as Dv, that is "defined variable or preprocessor constant"; pedantically they are neither. Of course I favor practicality over pedantics.

Why does the change not add Dv markup for the names of the constants? Is the user any more or less likely to search apropos Dv=EX_USAGE?

I can mostly grasp the rationale of the change, but I think you could do a little more to convince the reader of its value.