CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.2.0 - 2021-11-13

Changed

• status 9 (may not be empty) message
  • [<option>: ]argument [<n>: ]may not be (empty|blank) → [<option>: ]argument [<n>: ](may|must) not be (empty|blank)

2.1.0 - 2021-11-01

Changed

• status 101 (not enough memory) message and description
  • message: not enough [heap ]memory → not enough [(heap|kernel) ]memory
  • description: "[...] free memory on the heap to allocate a block of data." → "[...] free memory (either heap or kernel memory) to perform an operation."

2.0.0 - 2020-04-13

Added

• new status 98: <path>: too many levels of symbolic link
• new status 99: <filename>: filename too long
• new status 26: <item>: <itemtype> already exists
• new status 27: <program>: program missing
• glob(7) and regex(7) to See Also page section
• to status range 32 - 47 ((custom feedback statuses)) description
  • "[...] These should always be documented."
• to status 30 (connection timed out) message and description
  • message: [...][: waited <ms> ms]
  • description: "[...]¶<ms> may be how many milliseconds were waited."

Changed

• message format explanation in description
• statuses 26 (network error[: <info>]) - 29 (arithmetic error[: <info>]) positions to 28 - 31
• status range 79 - 98 ((custom configuration errors)) to 79 - 97 (-1)
• statuses 99 (memory error) - 102 (generic internal fault) positions to 100 - 103
• status range 103 - 122 ((custom internal faults)) to 104 - 122 (-1)
• swap status 25 (item not an itemtype) and status 26 (item already exists)
• status 103 (generic internal fault) description
  • "General internal fault.[...]" → "Generic internal fault.[...]"
• status 9 (may not be empty) description
  • "Program can not [...]" → "The program can not [...]"
• status 6 (unexpected option) description
  • "The seen option at this position with the set of combination and [...]" → "The spotted option at this position with the combination and [...]"

Fixed

• wording in description
• status 11 (out of range) description (typo fix)
  • "[...] be the minumum, floor, maximum [...]" → "[...] be the minimum, floor, maximum [...]"

Removed

• status 30: divided by 0 error
• status 31: (overflow|underflow) error

1.2.0 - 2021-11-13

Changed

• status 9 (may not be empty) message
  • [<option>: ]argument [<n>: ]may not be (empty|blank) → [<option>: ]argument [<n>: ](may|must) not be (empty|blank)

1.1.0 - 2021-11-01

Changed

• status 100 (not enough memory) message and description
  • message: not enough [heap ]memory → not enough [(heap|kernel) ]memory
  • description: "[...] free memory on the heap to allocate a block of data." → "[...] free memory (either heap or kernel memory) to perform an operation."

1.0.0 - 2019-05-11

Added

• new status 6: <option>: unexpected option
• new status 8: <argument>: unknown [sub]command
• new status 11: [<option>: ]<argument>: out of range[ (<relational_op> <limit>)]
• new statuses 32 - 47: (custom feedback error)
• to status 3 (missing arguments) description
  • "[...]¶<arguments> may be the placeholder name of the missing arguments."
• to status 4 (too many arguments) description
  • "[...]¶<n> may be the amount of arguments that are not needed."
• to status 7 (may not be empty) description
  • "[...]¶<n> is the position of the argument that is empty/blank and is only really needed when the program/option needs multiple arguments."
• [: <info>] and <option> placeholder explanation to description
• grep(1) to "See Also" page section

Changed

• status 6 (invalid argument) position to 7
• statuses 7 (may not be empty) & 8 (not a number) positions to 9 & 10
• status 9 (does not match) position to 12
• status range 10 - 15 ((custom usage errors)) to 13 - 23 (+5)
• statuses 16 (no such itemtype) & 17 (not an itemtype) positions to 24 & 25
• statuses 22 (network error) - 27 (overflow/underflow error) positions to 26 - 31
• statuses 28 (memory error) - 30 (stack overflow) positions to 99 - 101
• status 31 (emergency stop) position to 123
• status range 32 - 63 ((custom errors)) to 48 - 63 (-16)
• status range 79 - 99 ((custom configuration errors)) to 79 - 98 (-1)
• status 100 (generic internal fault) position to 102
• status range 101 - 123 ((custom internal faults)) to 103 - 122 (-2)
• status 3 (missing arguments) message
  • [<option>: ]missing argument(s)[: <arguments>...] → [<option>: ]missing argument[s][: <argument>...]
• status 7 (may not be empty) message
  • argument #<n>: may not be (empty|blank) → [<option>:]argument [<n>:]may not be (empty|blank)

Removed

• from status 8 (not a number) description
  • "[...]¶If a valid decimal number has been entered and this exit status is returned then you must convert the decimal number into an integer."

0.3.0 - 2019-05-06

Added

• new status 5: <option>: invalid option
• new status 7: argument #<n>: may not be (empty|blank)
• commoncodes.h C header file
• "See Also" page section with GitHub repo link

Changed

• status 5 (invalid argument) position: moved one code up
• status 6 (not a number) and status 7 (does not match) positions: moved two codes up
• status 21 (network error) to status 26 (overflow/underflow error) positions: moved one code up
• status 100 (internal fault) description
  • "[...] to a stage where user input is awaited." → "[...] to a next stage of execution."
• status 124 (interactive script call) description
  • "The script can [...]" → "The shell script can [...]"

Removed

• statuses 8 and 9: (custom usage errors)

0.2.0 - 2019-05-05

Added

• status 21: network error[: <info>]
• status 22: no network connection
• status 23: connection timed out
• status 30: stack overflow error
• explanation for the message synopsis to description

Changed

• status 29 (not enough memory) message and description
  • message: not enough memory → not enough [heap ]memory"
  • description: "[...] not enough memory to allocate [...]" → "[...] not enough free memory on the heap to allocate [...]"

0.1.0 - 2019-05-03

Added

• status 0: success
• status 1: generic error[: <info>]
• status 2: generic usage error[: <info>]
• status 3: [<option>: ]missing argument(s)[: <arguments>...]
• status 4: [<option>: ]too many arguments[: <n>]
• status 5: [<option>: ]<argument>: invalid argument[: <info>]
• status 6: [<option>: ]<argument>: not a[n] (number|integer)
• status 7: [<option>: ]<argument>: does not match: <pattern>
• status 8 - 15: (custom usage errors)
• status 16: <item>: no such <itemtype>[[, <itemtype>]... or <itemtype>]
• status 17: <item>: not a[n] <itemtype>[[, <itemtype>]... or <itemtype>]
• status 24: arithmetic error[: <info>]
• status 25: divided by 0 error
• status 26: (overflow|underflow) error
• status 28: memory error[: <info>]
• status 29: not enough memory
• status 31: emergency stop[: <info>]
• status 32 - 63: (custom errors)
• status 64: command line usage error[: <info>]
• status 65: data format error[: <info>]
• status 66: cannot open input[: <info>]
• status 67: addressee unknown[: <info>]
• status 68: host name unknown[: <info>]
• status 69: service unavailable[: <info>]
• status 70: internal software error[: <info>]
• status 71: system error[: <info>]
• status 72: critical OS file missing[: <info>]
• status 73: can't create (user) output file[: <info>]
• status 74: input/output error[: <info>]
• status 75: temp failure[: <info>]
• status 76: remote error in protocol[: <info>]
• status 77: permission denied[: <info>]
• status 78: configuration error[: <info>]
• status 79 - 99: (custom configuration errors)
• status 100: generic internal fault[: <info>]
• status 101 - 123: (custom internal faults)
• status 124: script was [not ]called interactively
• status 125: unknown error