Page MenuHomeFreeBSD

Create EX_*.3 manual page links to sysexits.3
AbandonedPublic

Authored by 0mp on Mar 30 2020, 5:08 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Jul 3, 8:30 AM
Unknown Object (File)
Jun 22 2024, 6:06 PM
Unknown Object (File)
Jun 9 2024, 9:29 AM
Unknown Object (File)
Jun 6 2024, 6:29 AM
Unknown Object (File)
May 20 2024, 11:33 AM
Unknown Object (File)
Apr 29 2024, 4:17 PM
Unknown Object (File)
Apr 2 2024, 4:00 AM
Unknown Object (File)
Mar 28 2024, 6:58 PM

Details

Reviewers
bcr
ngie
emaste
Summary
Create EX_*.3 manual page links to sysexits.3
Test Plan
export DESTDIR=/tmp/test1234
mkdir -p $DESTDIR

make hierarchy DESTDIR=$DESTDIR
cd share/man/man3
make build
make install DESTDIR=$DESTDIR

# Check /tmp/test1234

Diff Detail

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

Event Timeline

I'm looking for a review of 1 thing, really: is it beneficial to actually create those MLINKS.

After a quick chat with some other developers it looks like we would actually want to deprecate sysexits.

In D24224#533296, @0mp wrote:

After a quick chat with some other developers it looks like we would actually want to deprecate sysexits.

Thank you very much for taking the charge in cleaning up manpages, etc!

FWIW, I don't think it would be a good idea to document individual error codes. We don't have manpage links for EINVAL.2, etc, to errno(2).

As long as we're consistent with POSIX's documentation, I believe we're ok with the status quo, which is leaving the individual error codes documented only in sysexits(3).