From 96440b182c16ee6d7083fb651d27db2c489c7bb9 Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Sun, 5 May 2019 21:35:03 +0200 Subject: [PATCH 01/11] Added a version warning to 0.1.0.html --- docs/v/0.1.0.html | 7 +++++++ docs/versions.css | 25 +++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/docs/v/0.1.0.html b/docs/v/0.1.0.html index 7ebaaf2..de1d113 100644 --- a/docs/v/0.1.0.html +++ b/docs/v/0.1.0.html @@ -24,6 +24,13 @@

CommonCodes v0.1.0

May 2, 2019
+
+ + You are viewing and older version of CommonCodes, + click here to view the latest version. + +
+

CommonCodes is an attempt to standardize the diff --git a/docs/versions.css b/docs/versions.css index 8b3d2ab..66c2f01 100644 --- a/docs/versions.css +++ b/docs/versions.css @@ -7,6 +7,31 @@ #version-date_container { text-align: center; } #version-date_text { font-style: italic; } +#version-warning_container { text-align: center; } +#version-warning_text { color: #FF0000; } +#version-warning_text::selection { background: #FF0000; } +#version-warning_text a:link, +#version-warning_text a:visited { + color: #DF0000; + text-decoration: underline; +} +#version-warning_text a:hover { + color: #BF0000; + text-decoration: none; +} +#version-warning_text a:active { + color: #9F0000; + text-decoration: none; +} +#version-warning_text a:link::selection { background: #FF0000; } +#version-warning_text a:link::-moz-selection { background: #FF0000; } +#version-warning_text a:visited::selection { background: #DF0000; } +#version-warning_text a:visited::-moz-selection { background: #DF0000; } +#version-warning_text a:hover::selection { background: #BF0000; } +#version-warning_text a:hover::-moz-selection { background: #BF0000; } +#version-warning_text a:active::selection { background: #9F0000; } +#version-warning_text a:active::-moz-selection { background: #9F0000; } + .synopsis_controls { font-weight: bold; } .synopsis_placeholder { font-style: italic; From b5e1e1540cb2a3deb2e6f7ad656298ca61720d5f Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Sun, 5 May 2019 21:49:35 +0200 Subject: [PATCH 02/11] Put heading, date and version warning a bit closer together --- docs/versions.css | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/versions.css b/docs/versions.css index 66c2f01..6f3f4aa 100644 --- a/docs/versions.css +++ b/docs/versions.css @@ -1,3 +1,10 @@ +#header { margin-bottom: 1em; } + +h1 { + margin-top: 0; + margin-bottom: 0.25rem; +} + #version-links_container { font-size: 1.2em; text-align: center; @@ -7,8 +14,11 @@ #version-date_container { text-align: center; } #version-date_text { font-style: italic; } -#version-warning_container { text-align: center; } -#version-warning_text { color: #FF0000; } +#version-warning_container { + text-align: center; + margin-top: 0.25rem; +} +#version-warning_text { color: #FF0000; } #version-warning_text::selection { background: #FF0000; } #version-warning_text a:link, #version-warning_text a:visited { From c965f5428c08f3e63deaa1a1b4f4ca3570377b31 Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Mon, 6 May 2019 11:53:47 +0200 Subject: [PATCH 03/11] Tweaked description of code 100 a bit Added 0.3.0.html and links to it in other version pages --- CHANGELOG.md | 8 + commoncodes.7 | 4 +- docs/v/0.1.0.html | 1 + docs/v/0.2.0.html | 1 + docs/v/0.3.0.html | 415 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 427 insertions(+), 2 deletions(-) create mode 100644 docs/v/0.3.0.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 51233c3..555acfd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] - 2019-05-06 ## + +### Changed ### + +* Tweaked description of code 100 a bit + +[Unreleased]: https://github.com/SpEZiiL/commoncodes/compare/v0.2.0...develop + ## [0.2.0] - 2019-05-05 ## ### Added ### diff --git a/commoncodes.7 b/commoncodes.7 index 4c06794..67a8525 100644 --- a/commoncodes.7 +++ b/commoncodes.7 @@ -30,7 +30,7 @@ .\} .. -.TH commoncodes 7 "0.2.0" "May 05, 2019" "CommonCodes man page" +.TH commoncodes 7 "0.3.0" "May 06, 2019" "CommonCodes man page" .SH NAME CommonCodes \- Standardized list of commonly used exit statuses @@ -273,7 +273,7 @@ should always be documented. General internal fault. .br An internal fault happens when preconditions prevent the program to advance to a -stage where user input is awaited. +next stage of execution. .IP "101 - 123" .B (custom internal faults) .br diff --git a/docs/v/0.1.0.html b/docs/v/0.1.0.html index de1d113..3b80a41 100644 --- a/docs/v/0.1.0.html +++ b/docs/v/0.1.0.html @@ -13,6 +13,7 @@

diff --git a/docs/v/0.2.0.html b/docs/v/0.2.0.html index fa3157e..9e7d8a7 100644 --- a/docs/v/0.2.0.html +++ b/docs/v/0.2.0.html @@ -12,20 +12,29 @@ + + [ + v0.3.0 (unreleased) | + v0.2.0 | + v0.1.0 + ] + +
+ -
+
+

CommonCodes v0.2.0

-
May 5, 2019
+
+ May 5, 2019 +
+
+ +
+
+

Description

-

CommonCodes is an attempt to standardize the meaning of exit statuses of programs written for Unix like systems. @@ -75,7 +84,10 @@

CommonCodes v0.2.0

displayed if they are separated by bold vertical bars(|). -
+
+ +
+

Status Code Table

@@ -396,9 +408,10 @@

CommonCodes v0.2.0

-
Status Codes
Cause of error is not known, not even to the developer.
+ +
-
+

Footnotes

@@ -407,12 +420,13 @@

Footnotes

when distributing for GNU/Linux systems and code 64 when distributing for BSD systems.

-
-
+
+
+
+ © 2019 Michael Federczuk + + diff --git a/docs/v/0.3.0.html b/docs/v/0.3.0.html index d09af70..0d18de1 100644 --- a/docs/v/0.3.0.html +++ b/docs/v/0.3.0.html @@ -12,28 +12,36 @@ + + [ + v0.3.0 (unreleased) | + v0.2.0 | + v0.1.0 + ] + + + -
+
+

CommonCodes v0.3.0

-
May 6, 2019
+
+ May 6, 2019 +
- You are viewing and unreleased version of CommonCodes, - click here to view the latest released - version. - -
+ You are viewing and unreleased version of CommonCodes, click + here to view the latest released version. + +
+
+ +
+
+

Description

-

CommonCodes is an attempt to standardize the meaning of exit statuses of programs written for Unix like systems. @@ -83,7 +91,10 @@

CommonCodes v0.3.0

displayed if they are separated by bold vertical bars(|). -
+
+ +
+

Status Code Table

@@ -417,9 +428,10 @@

CommonCodes v0.3.0

-
Status Codes
Cause of error is not known, not even to the developer.
+ +
-
+

Footnotes

@@ -428,12 +440,13 @@

Footnotes

when distributing for GNU/Linux systems and code 64 when distributing for BSD systems.

-
-
+
+
+ + © 2019 Michael Federczuk + + diff --git a/docs/versions.css b/docs/versions.css index 6f3f4aa..77df34a 100644 --- a/docs/versions.css +++ b/docs/versions.css @@ -1,16 +1,18 @@ +/* header */ #header { margin-bottom: 1em; } +#version-links_container { text-align: center; } +#version-links_text { font-size: 1.2em; } +#version-links_current { font-weight: bold; } + +/* body */ +#body { margin-bottom: 1em; } + h1 { margin-top: 0; margin-bottom: 0.25rem; } -#version-links_container { - font-size: 1.2em; - text-align: center; -} -#version-links_current { font-weight: bold; } - #version-date_container { text-align: center; } #version-date_text { font-style: italic; } @@ -42,13 +44,13 @@ h1 { #version-warning_text a:active::selection { background: #9F0000; } #version-warning_text a:active::-moz-selection { background: #9F0000; } +#status-code-table caption { display: none; } + .synopsis_controls { font-weight: bold; } .synopsis_placeholder { font-style: italic; text-decoration: underline; } -#footer { - margin-top: 1em; - text-align: center; -} +/* footer */ +#footer { text-align: center; } From 1928541925b2956e300342ddde20c6d2c1a392b0 Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Mon, 6 May 2019 18:18:51 +0200 Subject: [PATCH 08/11] Added 'See Also' section --- CHANGELOG.md | 1 + commoncodes.7 | 3 +++ docs/v/0.3.0.html | 9 +++++++++ 3 files changed, 13 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c377f37..b719d68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added ### * `commoncodes.h` C header file +* **See Also** page section with GitHub repo link ### Changed ### diff --git a/commoncodes.7 b/commoncodes.7 index 512cf12..9cbeb71 100644 --- a/commoncodes.7 +++ b/commoncodes.7 @@ -308,5 +308,8 @@ systems and code 64 when distributing for .B BSD systems. +.SH SEE ALSO + + .SH AUTHOR Michael Federczuk diff --git a/docs/v/0.3.0.html b/docs/v/0.3.0.html index 0d18de1..e5b30f7 100644 --- a/docs/v/0.3.0.html +++ b/docs/v/0.3.0.html @@ -441,6 +441,15 @@

Footnotes

when distributing for BSD systems.

+ + + From 3ca13b56e412787a21fd5c1685fee5e965845d3f Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Mon, 6 May 2019 20:11:09 +0200 Subject: [PATCH 09/11] Added compare pages Hand made comparison between two adjacent versions --- CHANGELOG.md | 2 +- docs/diff.css | 20 ++ docs/v/0.1.0...0.2.0.html | 441 +++++++++++++++++++++++++++++++++++ docs/v/0.1.0.html | 2 + docs/v/0.2.0...0.3.0.html | 471 ++++++++++++++++++++++++++++++++++++++ docs/v/0.2.0.html | 8 +- docs/v/0.3.0.html | 4 +- docs/versions.css | 3 +- 8 files changed, 947 insertions(+), 4 deletions(-) create mode 100644 docs/diff.css create mode 100644 docs/v/0.1.0...0.2.0.html create mode 100644 docs/v/0.2.0...0.3.0.html diff --git a/CHANGELOG.md b/CHANGELOG.md index b719d68..e406fa1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,7 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Status 29: Tweaked message a bit * "not enough memory" → "not enough [heap ]memory" -[0.2.0]: https://speziil.github.io/commoncodes/v/0.2.0.html +[0.2.0]: https://speziil.github.io/commoncodes/v/0.1.0...0.2.0.html ## [0.1.0] - 2019-05-03 ## diff --git a/docs/diff.css b/docs/diff.css new file mode 100644 index 0000000..93e7b29 --- /dev/null +++ b/docs/diff.css @@ -0,0 +1,20 @@ +.diff_addition { + color: #00EF00; + background-color: rgba(0, 255, 0, 0.125); +} +.diff_addition::selection, .diff_addition *::selection { background-color: #00DF00; } +.diff_addition::-moz-selection, .diff_addition *::-moz-selection { background-color: #00DF00; } + +.diff_deletion { + color: #EF0000; + background-color: rgba(255, 0, 0, 0.125); +} +.diff_deletion::selection, .diff_deletion *::selection { background-color: #DF0000; } +.diff_deletion::-moz-selection, .diff_deletion *::-moz-selection { background-color: #DF0000; } + +.diff_change { + color: #EFEF00; + background-color: rgba(255, 255, 0, 0.125); +} +.diff_change::selection, .diff_change *::selection { background-color: #DFDF00; } +.diff_change::-moz-selection, .diff_change *::-moz-selection { background-color: #DFDF00; } diff --git a/docs/v/0.1.0...0.2.0.html b/docs/v/0.1.0...0.2.0.html new file mode 100644 index 0000000..10b60e1 --- /dev/null +++ b/docs/v/0.1.0...0.2.0.html @@ -0,0 +1,441 @@ + + + + CommonCodes v0.2.0 + + + + + + + + + + + +
+
+

CommonCodes v0.2.0

+ +
+ May 5, 2019 +
+ +
+ latest release +
+
+ +
+
+

Description

+ +

+ CommonCodes is an attempt to standardize the + meaning of exit statuses of programs written for Unix like systems. +

+ +

+ CommonCodes includes the 15 exit codes defined by + BSD in sysexits.h that range from 64 to 78. +

+ +

+ GNU Bash uses the exit status 2 to + indicate incorrect usage of a shell builtins. + Bash also uses codes above 125 for special exit + statuses like termination by a sent signal.
+ CommonCodes adopts both of these rules, using 2 as + a generic usage error and not defining any codes above 125. +

+ +

+ Some ranges have been kept empty so that developers may add error + messages of their own, tailored to the program that they are writing.
+ If codes in these ranges are defined then they should always be + documented, either in the --help summary or in the + manpage. +

+ +
+

+ In the following table, these rules apply for the messages: +

+ +
    +
  • + Italic and/or underlined symbols are placeholders for other text + that should get replaced for real messages. +
    • +
  • + Text and symbols in bold square brackets may be ommitted in real + messages. +
    • +
  • + Text and symbols followed by bold ellipsis may be repeated one or + more times in real messages. +
    • +
  • + In real messages, only one field of text and symbols may be + displayed if they are separated by bold vertical bars(|). +
    • +
+
+
+ +
+

Status Code Table

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status Codes
Exit CodeMessageDescription
0success + The program executed successfully or the --help + or the --version options were specified. +
1generic error[: info]Any other error that doesn't fit in any other category.
2generic usage error[: info] + Any other program usage error that doesn't fit in any other + category. +
3[option: ]missing argument(s)[: arguments...] + Not enough arguments have been passed down to the program or + to an option of the program. +
4[option: ]too many arguments[: n] + Too many arguments have been passed down to the program or + to an option of the program. +
5[option: ]argument: invalid argument[: info]The argument is invalid and cannot be used.
6[option: ]argument: not a[n] (number|integer) + The argument is not a valid number or is not a valid integer.
+ If a valid decimal number has been entered and this exit + status is returned then you must convert the decimal number + into an integer. +
7[option: ]argument: does not match: pattern + The argument does not match the pattern provided. The + pattern can be glob, regex or any other pattern matching + system. +
8 - 15(custom usage errors) + Usage errors defined by the developer of the program. These + should always be documented. +
16item: no such itemtype[[, itemtype]... or itemtype] + The item in question could not be found.
+ item can be things like paths, etc. and itemtype + can be things like regular files, directories, etc. +
17item: not a[n] itemtype[[, itemtype]... or itemtype]The item in question is of the wrong type.
18?
19?
20?
21network error[: info]?A general network error occurred.
22no network connection?No network connection is established.
23connection timed out?A network request took too long and timed out.
24arithmetic error[: info]A general arithmetic error occurred.
25divided by 0 errorA division by 0 was tried to be executed and there was no fallback option.
26(overflow|underflow) error + An overflow or underflow happened and it has critical + effects on the program. +
27?
28memory error[: info]A general memory error occurred.
29not enough [heap ]memoryThere was not enough free memory on the heap to allocate a block of data.
30stack overflow error?A stack overflow occurred.
31emergency stop[: info] + The program was intentionally halted by the developer + because a value is invalid and can't be worked with. +
32 - 63(custom errors) + General custom errors defined by the developer. + These should always be documented. +
64command line usage error[: info] + The command was used incorrectly, e.g., with the wrong + number of arguments, a bad flag, a bad syntax in a parameter, + or whatever. +
65data format error[: info]The input data was incorrect in some way.
66cannot open input[: info] + An input file (not a system file) did not exist or was not + readable. This could also include errors like "No message" + to a mailer (if it cared to catch it). +
67addressee unknown[: info]The user specified did not exist.
68host name unknown[: info]The host specified did not exist.
69service unavailable[: info] + A service is unavailable. This can occur if a support + program or file does not exist. +
70internal software error[: info]An internal software error has been detected.
71system error[: info]An operating system error has been detected.
72critical OS file missing[: info] + Some system file (e.g., /etc/passwd, /etc/utmp, etc.) does + not exist, cannot be opened, or has some sort of error (e.g., + syntax error). +
73can't create (user) output file[: info]A (user specified) output file cannot be created.
74input/output error[: info]An error occurred while doing I/O on some file.
75temp failure[: info] + Temporary failure, indicating something that is not really + an error. +
76remote error in protocol[: info] + The remote system returned something that was "not possible" + during a protocol exchange. +
77permission denied[: info] + You did not have sufficient permission to perform the + operation. +
78configuration error[: info] + Something was found in an unconfigured or misconfigured + state. +
79 - 99(custom configuration errors) + Configuration, property and setting errors defined by the + developer. These should always be documented. +
100generic internal fault[: info] + General internal fault.
+ An internal fault happens when preconditions prevent the + program to advance to a stage where user input is awaited. +
101 - 123(custom internal faults) + Different internal faults, defined by the developer. These + should always be documented. +
124script was [not ]called interactively + The script can either only be executed interactively (using + command "." or "source"), or not interactively (executing + via "./"). +
125unknown errorCause of error is not known, not even to the developer.
+
+ +
+

Footnotes

+ +

+ Since exit code 2 (generic usage error) and exit code 64 (command line + usage error) are basically the same, it is recommended to use code 2 + when distributing for GNU/Linux systems and code 64 + when distributing for BSD systems. +

+
+
+
+ + + + diff --git a/docs/v/0.1.0.html b/docs/v/0.1.0.html index 8610323..8a0a392 100644 --- a/docs/v/0.1.0.html +++ b/docs/v/0.1.0.html @@ -15,7 +15,9 @@ [ v0.3.0 (unreleased) | + ... | v0.2.0 | + ... | v0.1.0 ] diff --git a/docs/v/0.2.0...0.3.0.html b/docs/v/0.2.0...0.3.0.html new file mode 100644 index 0000000..8e67a99 --- /dev/null +++ b/docs/v/0.2.0...0.3.0.html @@ -0,0 +1,471 @@ + + + + CommonCodes v0.3.0 + + + + + + + + + + + +
+
+

CommonCodes v0.3.0

+ +
+ May 6, 2019 +
+ +
+ + You are viewing and unreleased version of CommonCodes, click + here to view the latest released version. + +
+
+ +
+
+

Description

+ +

+ CommonCodes is an attempt to standardize the + meaning of exit statuses of programs written for Unix like systems. +

+ +

+ CommonCodes includes the 15 exit codes defined by + BSD in sysexits.h that range from 64 to 78. +

+ +

+ GNU Bash uses the exit status 2 to + indicate incorrect usage of shell builtins. + Bash also uses codes above 125 for special exit + statuses like termination by a sent signal.
+ CommonCodes adopts both of these rules, using 2 as + a generic usage error and not defining any codes above 125. +

+ +

+ Some ranges have been kept empty so that developers may add error + messages of their own, tailored to the program that they are writing.
+ If codes in these ranges are defined then they should always be + documented, either in the --help summary or in the + manpage. +

+ +

+ In the following table, these rules apply for the messages: +

+ +
    +
  • + Italic and/or underlined symbols are placeholders for other text + that should get replaced for real messages. +
    • +
  • + Text and symbols in bold square brackets may be ommitted in real + messages. +
    • +
  • + Text and symbols followed by bold ellipsis may be repeated one or + more times in real messages. +
    • +
  • + In real messages, only one field of text and symbols may be + displayed if they are separated by bold vertical bars(|). +
    • +
+
+ +
+

Status Code Table

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status Codes
Exit CodeMessageDescription
0success + The program executed successfully or the --help + or the --version options were specified. +
1generic error[: info]Any other error that doesn't fit in any other category.
2generic usage error[: info] + Any other program usage error that doesn't fit in any other + category. +
3[option: ]missing argument(s)[: arguments...] + Not enough arguments have been passed down to the program or + to an option of the program. +
4[option: ]too many arguments[: n] + Too many arguments have been passed down to the program or + to an option of the program. +
5[option: ]argument: invalid optionargument[: info]The entered option is not specified in the programargument is invalid and cannot be used.
6[option: ]argument: invalid argument[: info]not a[n] (number|integer) + The argument is invalid and cannot be usednot a valid number or is not a valid integer.
+ If a valid decimal number has been entered and this exit status is returned then you must convert the decimal number into an integer. +
7 + argument #n: may not be (empty|blank)
+ [option: ]argument: does not match: pattern + 		+ Program can not work with empty or blank argument.¶
+ "Blank" means none or only whitespace characters.
+ The argument does not match the pattern provided. The pattern can be glob, regex or any other pattern matching system. +
8[option: ]argument: not a[n] (number|integer) + The argument is not a valid number or is not a valid integer.¶
+ If a valid decimal number has been entered and this exit + status is returned then you must convert the decimal number + into an integer. +
9[option: ]argument: does not match: pattern + The argument does not match the pattern provided. The + pattern can be glob, regex or any other pattern matching + system. +
108 - 15(custom usage errors) + Usage errors defined by the developer of the program. These + should always be documented. +
16item: no such itemtype[[, itemtype]... or itemtype] + The item in question could not be found.
+ item can be things like paths, etc. and itemtype + can be things like regular files, directories, etc. +
17item: not a[n] itemtype[[, itemtype]... or itemtype]The item in question is of the wrong type.
18?
19?
20?
21network error[: info]A general network error occurred.
22no network connectionNo network connection is established.
23connection timed outA network request took too long and timed out.
24arithmetic error[: info]A general arithmetic error occurred.
25divided by 0 errorA division by 0 was tried to be executed and there was no fallback option.
26(overflow|underflow) error + An overflow or underflow happened and it has critical + effects on the program. +
27?
28memory error[: info]A general memory error occurred.
29not enough [heap ]memoryThere was not enough free memory on the heap to allocate a block of data.
30stack overflow errorA stack overflow occurred.
31emergency stop[: info] + The program was intentionally halted by the developer + because a value is invalid and can't be worked with. +
32 - 63(custom errors) + General custom errors defined by the developer. + These should always be documented. +
64command line usage error[: info] + The command was used incorrectly, e.g., with the wrong + number of arguments, a bad flag, a bad syntax in a parameter, + or whatever. +
65data format error[: info]The input data was incorrect in some way.
66cannot open input[: info] + An input file (not a system file) did not exist or was not + readable. This could also include errors like "No message" + to a mailer (if it cared to catch it). +
67addressee unknown[: info]The user specified did not exist.
68host name unknown[: info]The host specified did not exist.
69service unavailable[: info] + A service is unavailable. This can occur if a support + program or file does not exist. +
70internal software error[: info]An internal software error has been detected.
71system error[: info]An operating system error has been detected.
72critical OS file missing[: info] + Some system file (e.g., /etc/passwd, /etc/utmp, etc.) does + not exist, cannot be opened, or has some sort of error (e.g., + syntax error). +
73can't create (user) output file[: info]A (user specified) output file cannot be created.
74input/output error[: info]An error occurred while doing I/O on some file.
75temp failure[: info] + Temporary failure, indicating something that is not really + an error. +
76remote error in protocol[: info] + The remote system returned something that was "not possible" + during a protocol exchange. +
77permission denied[: info] + You did not have sufficient permission to perform the + operation. +
78configuration error[: info] + Something was found in an unconfigured or misconfigured + state. +
79 - 99(custom configuration errors) + Configuration, property and setting errors defined by the + developer. These should always be documented. +
100generic internal fault[: info] + General internal fault.
+ An internal fault happens when preconditions prevent the + program to advance to a next stage of executionwhere user input is awaited. +
101 - 123(custom internal faults) + Different internal faults, defined by the developer. These + should always be documented. +
124script was [not ]called interactively + The shell script can either only be executed interactively + (using command "." or "source"), or not interactively + (executing via "./"). +
125unknown errorCause of error is not known, not even to the developer.
+
+ +
+

Footnotes

+ +

+ Since exit code 2 (generic usage error) and exit code 64 (command line + usage error) are basically the same, it is recommended to use code 2 + when distributing for GNU/Linux systems and code 64 + when distributing for BSD systems. +

+
+ + + +
+
+ + + + diff --git a/docs/v/0.2.0.html b/docs/v/0.2.0.html index 9e7d8a7..ea6767b 100644 --- a/docs/v/0.2.0.html +++ b/docs/v/0.2.0.html @@ -15,12 +15,14 @@ [ v0.3.0 (unreleased) | + ... | v0.2.0 | + ... | v0.1.0 ] - +
@@ -29,6 +31,10 @@

CommonCodes v0.2.0

May 5, 2019
+ +
+ latest release +
diff --git a/docs/v/0.3.0.html b/docs/v/0.3.0.html index e5b30f7..874580c 100644 --- a/docs/v/0.3.0.html +++ b/docs/v/0.3.0.html @@ -15,12 +15,14 @@ [ v0.3.0 (unreleased) | + ... | v0.2.0 | + ... | v0.1.0 ]
-
+
diff --git a/docs/versions.css b/docs/versions.css index 77df34a..d956f88 100644 --- a/docs/versions.css +++ b/docs/versions.css @@ -16,7 +16,8 @@ h1 { #version-date_container { text-align: center; } #version-date_text { font-style: italic; } -#version-warning_container { +#version-warning_container, +#version-notice_container { text-align: center; margin-top: 0.25rem; } From 66d052d9278dee94a86837deab86c9084a16c751 Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Mon, 6 May 2019 20:40:12 +0200 Subject: [PATCH 10/11] Moved statuses 21 - 26 one code up --- CHANGELOG.md | 2 ++ commoncodes.7 | 14 +++++++------- commoncodes.h | 16 ++++++++-------- docs/v/0.2.0...0.3.0.html | 36 ++++++++++++++++++------------------ docs/v/0.3.0.html | 21 ++++++++++----------- 5 files changed, 45 insertions(+), 44 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e406fa1..6bd1b71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Status "_argument_: invalid argument" is now code 6 * Status "argument #_n_: may not be empty/blank" is now code 7 * Status "_argument_: not a number/integer" is now code 8 +* Moved statuses 21 - 26 one code up + e.g.: 21 → 22, and 26 → 27 [Unreleased]: https://github.com/SpEZiiL/commoncodes/compare/v0.2.0...develop diff --git a/commoncodes.7 b/commoncodes.7 index 9cbeb71..285f323 100644 --- a/commoncodes.7 +++ b/commoncodes.7 @@ -160,31 +160,31 @@ The item in question is of the wrong type. .IP 20 ? .IP 21 +? +.IP 22 .rbi "network error" "[" "" ": " "" "info" "" "]" .br A general network error occurred. -.IP 22 +.IP 23 no network connection .br No network connection is established. -.IP 23 +.IP 24 connection timed out .br A network request took too long and timed out. -.IP 24 +.IP 25 .rbi "arithmetic error" "[" "" ": " "" "info" "" "]" .br A general arithmetic error occured. -.IP 25 +.IP 26 divided by 0 error .br A division by 0 was tried to be executed and there was no fallback option. -.IP 26 +.IP 27 .bir "(" "" "overflow" "|" "" "underflow" ")" "" " error" .br An overflow or underflow happened and it has critical effects on the program. -.IP 27 -? .IP 28 .rbi "memory error" "[" "" ": " "" "info" "" "]" .br diff --git a/commoncodes.h b/commoncodes.h index 29319fb..75e0a0e 100644 --- a/commoncodes.h +++ b/commoncodes.h @@ -40,14 +40,14 @@ /* #define CC_ 18 */ /* #define CC_ 19 */ /* #define CC_ 20 */ -#define CC_NET_ERR 21 /* network error */ -#define CC_NO_NET_CON 22 /* no network connection */ -#define CC_CON_TIMED_OUT 23 /* connection timed out */ -#define CC_ARIT_ERR 24 /* arithmetic error */ -#define CC_DIV_BY_0_ERR 25 /* divied by 0 error */ -#define CC_OFLOW_ERR 26 /* overflow error */ -#define CC_UFLOW_ERR 26 /* underflow error */ -/* #define CC_ 27 */ +/* #define CC_ 21 */ +#define CC_NET_ERR 22 /* network error */ +#define CC_NO_NET_CON 23 /* no network connection */ +#define CC_CON_TIMED_OUT 24 /* connection timed out */ +#define CC_ARIT_ERR 25 /* arithmetic error */ +#define CC_DIV_BY_0_ERR 26 /* divied by 0 error */ +#define CC_OFLOW_ERR 27 /* overflow error */ +#define CC_UFLOW_ERR 27 /* underflow error */ #define CC_MEM_ERR 28 /* memory error */ #define CC_NO_MEM 29 /* not enough memory */ #define CC_NO_HMEM 29 /* not enough heap memory */ diff --git a/docs/v/0.2.0...0.3.0.html b/docs/v/0.2.0...0.3.0.html index 8e67a99..a77f82b 100644 --- a/docs/v/0.2.0...0.3.0.html +++ b/docs/v/0.2.0...0.3.0.html @@ -229,41 +229,42 @@

Status Code Table

21 - network error[: info] - A general network error occurred. + ?network error[: info] + A general network error occurred. 22 - no network connection - No network connection is established. + network error[: info]no network connection + A general network error occurredNo network connection is established. 23 - connection timed out - A network request took too long and timed out. + no network connectionconnection timed out + No network connection is establishedA network request took too long and timed out. 24 - arithmetic error[: info] - A general arithmetic error occurred. + connection timed outarithmetic error[: info] + A network request took too long and timed outgeneral arithmetic error occurred. 25 - divided by 0 error - A division by 0 was tried to be executed and there was no fallback option. + arithmeticdivided by 0 error[: info] + A general arithmetic error occurreddivision by 0 was tried to be executed and there was no fallback option. 26 - (overflow|underflow) error - - An overflow or underflow happened and it has critical - effects on the program. - + divided by 0(overflow|underflow) error + A division by 0 was tried to be executed and there was no fallback optionAn overflow or underflow happened and it has critical + effects on the program. 27 - ? - + (overflow|underflow) error? + + An overflow or underflow happened and it has critical + effects on the program. + 28 @@ -459,7 +460,6 @@

See Also

<https://github.com/SpEZiiL/commoncodes>

-
diff --git a/docs/v/0.3.0.html b/docs/v/0.3.0.html index 874580c..45685ed 100644 --- a/docs/v/0.3.0.html +++ b/docs/v/0.3.0.html @@ -221,42 +221,42 @@

Status Code Table

21 + ? + + + + 22 network error[: info] A general network error occurred. - 22 + 23 no network connection No network connection is established. - 23 + 24 connection timed out A network request took too long and timed out. - 24 + 25 arithmetic error[: info] A general arithmetic error occurred. - 25 + 26 divided by 0 error A division by 0 was tried to be executed and there was no fallback option. - 26 + 27 (overflow|underflow) error An overflow or underflow happened and it has critical effects on the program. - - 27 - ? - - 28 memory error[: info] @@ -451,7 +451,6 @@

See Also

<https://github.com/SpEZiiL/commoncodes>

- From 8a376ec71cd841c27ebf679d88d6e74515c25d5d Mon Sep 17 00:00:00 2001 From: Michael Federczuk Date: Mon, 6 May 2019 20:45:56 +0200 Subject: [PATCH 11/11] v0.3.0 release --- CHANGELOG.md | 4 ++-- docs/v/0.1.0...0.2.0.html | 11 +++++++---- docs/v/0.1.0.html | 2 +- docs/v/0.2.0...0.3.0.html | 11 ++++------- docs/v/0.2.0.html | 11 +++++++---- docs/v/0.3.0.html | 11 ++++------- docs/v/latest.html | 2 +- 7 files changed, 26 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bd1b71..8a09d0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] - 2019-05-06 ## +## [0.3.0] - 2019-05-06 ## ### Added ### @@ -27,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Moved statuses 21 - 26 one code up e.g.: 21 → 22, and 26 → 27 -[Unreleased]: https://github.com/SpEZiiL/commoncodes/compare/v0.2.0...develop +[0.3.0]: https://speziil.github.io/commoncodes/v/0.2.0...0.3.0.html ## [0.2.0] - 2019-05-05 ## diff --git a/docs/v/0.1.0...0.2.0.html b/docs/v/0.1.0...0.2.0.html index 10b60e1..5b4b1c1 100644 --- a/docs/v/0.1.0...0.2.0.html +++ b/docs/v/0.1.0...0.2.0.html @@ -15,7 +15,7 @@ -
- latest release -
+
+ + You are viewing and older version of CommonCodes, click + here to view the latest version. + +
diff --git a/docs/v/0.1.0.html b/docs/v/0.1.0.html index 8a0a392..2acb262 100644 --- a/docs/v/0.1.0.html +++ b/docs/v/0.1.0.html @@ -14,7 +14,7 @@
diff --git a/docs/v/0.2.0.html b/docs/v/0.2.0.html index ea6767b..be7a65c 100644 --- a/docs/v/0.2.0.html +++ b/docs/v/0.2.0.html @@ -14,7 +14,7 @@ -
- latest release -
+
+ + You are viewing and older version of CommonCodes, click + here to view the latest version. + +
diff --git a/docs/v/0.3.0.html b/docs/v/0.3.0.html index 45685ed..f7366b1 100644 --- a/docs/v/0.3.0.html +++ b/docs/v/0.3.0.html @@ -14,7 +14,7 @@ -
- - You are viewing and unreleased version of CommonCodes, click - here to view the latest released version. - -
+
+ latest release +
diff --git a/docs/v/latest.html b/docs/v/latest.html index fbd447d..0de6ef8 120000 --- a/docs/v/latest.html +++ b/docs/v/latest.html @@ -1 +1 @@ -0.2.0.html \ No newline at end of file +0.3.0.html \ No newline at end of file