New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sysexits: tidy deprecated header and manual #1195
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With these 2 corrections (and the same change in the commit message for consistency), it looks good to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the false start (I'm going to ask you to undo a couple of this, for which I apologize).
share/man/man3/sysexits.3
Outdated
@@ -29,7 +29,7 @@ | |||
.Os | |||
.Sh NAME | |||
.Nm sysexits | |||
.Nd preferable exit codes for programs | |||
.Nd 4.4BSD exit codes for programs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, apologies for multiple comments.... I'd just delete preferable from the original.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the header, I like that, but the document description feels different because of apropos.
How's "s/preferable/sendmail/"? I would use "sendmail style" but I'm worried about it clogging output of "man -k style" when people are trying to learn about writing.
No need to apologize, seriously, thank you. How's this latest one? |
2e7e0b1
to
cb24b4e
Compare
<sysexits.h> was officially deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. MFC after: 1 week Co-authored-by: imp Reported by: llfw Reviewed by: imp, pauamma Signed-off-by: Alexander Ziaee <concussious@runbox.com> Pull Request: freebsd#1195
<sysexits.h> was officially deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. MFC after: 1 week Co-authored-by: imp Reviewed by: imp, pauamma Signed-off-by: Alexander Ziaee <concussious@runbox.com> Pull Request: freebsd#1195
<sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. Tidy the header and manual, and match what Net/OpenBSD is doing regarding this in intro(1). MFC after: 3 days Co-authored-by: imp Reviewed by: imp, pauamma Signed-off-by: Alexander Ziaee <concussious@runbox.com> Pull Request: freebsd#1195
I'll review this in the morning |
Related: https://reviews.freebsd.org/D27176 |
<sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. Tidy the header and manual, and match what Net/OpenBSD is doing regarding this in intro(1). MFC after: 3 days Co-authored-by: imp Reviewed by: imp, pauamma Obtained from: NetBSD, OpenBSD Signed-off-by: Alexander Ziaee <concussious@runbox.com> Pull Request: freebsd#1195
I don't know how to proceed from here since this is basically a duplicate of what's already being worked on. In the differential thread, jilles mentioned some other common exit codes. I think they should be noted in the system manual somewhere, and this seems like the place even though it's describing the sysexits interface. From what I've been able to find (which may not be exhaustive), there's only errno(2) for syscalls and sysexits(3) for programs, so... this seems like the place? |
<sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. MFC after: 1 week Co-authored-by: imp Reviewed by: imp, pauamma Pull Request freebsd#1195
<sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. MFC after: 1 week Co-authored-by: imp Reviewed by: imp, pauamma (previous version) Pull Request freebsd#1195
<sysexits.h> was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. MFC after: 1 week Co-authored-by: imp Reviewed by: imp, pauamma (previous version) Pull Request freebsd#1195
Proposed changes to intro(1) exit status reverted. Even though it's part of this idea, I'm thinking it should be its own discussion. The changes here don't make any of it incorrect. Edit: but I did put an altered line from intro(1) (that otherBSDs trimmed) into the first sentance of sysexits(3). Attempting to preserve the brevity we've arrived at, while still explaining what the manual page is about. |
I was originally intending to rewrite intro.1 but then I thought it really needs to go in sysexits.{3/h}. Is my syntax for the commit log correct? Some of these sentences are verbatim not mine.
Thank you so much for going out of your way to include me in this game, it's really enriching my life and very meaningful to me.