Skip to content
Snippets Groups Projects
Commit a31e16f4 authored by Simon McVittie's avatar Simon McVittie
Browse files

docs: Improve consistency of how we document sysexits.h status codes

parent bdbfe704
No related branches found
No related tags found
No related merge requests found
...@@ -44,9 +44,8 @@ Unstructured diagnostic messages appear on standard error. ...@@ -44,9 +44,8 @@ Unstructured diagnostic messages appear on standard error.
: **steam-runtime-check-requirements** ran successfully and all the Steam : **steam-runtime-check-requirements** ran successfully and all the Steam
client requirements are met. client requirements are met.
71 71 (`EX_OSERR` from `sysexits.h`)
: At least one of the requirements is not met. In this case the exit status : At least one of the requirements is not met.
will be 71 (EX_OSERR).
Other Nonzero Other Nonzero
: An error occurred. : An error occurred.
......
...@@ -60,8 +60,8 @@ the `LD_LIBRARY_PATH` Steam Runtime) but unsuitable for more general uses. ...@@ -60,8 +60,8 @@ the `LD_LIBRARY_PATH` Steam Runtime) but unsuitable for more general uses.
0 0
: Success. : Success.
64 64 (`EX_USAGE` from `sysexits.h`)
: Invalid arguments were given (EX_USAGE). : Invalid arguments were given.
Other Nonzero Other Nonzero
: An error occurred. : An error occurred.
......
...@@ -300,7 +300,7 @@ inherits standard error. ...@@ -300,7 +300,7 @@ inherits standard error.
or by *NAME* being replaced by another process or by *NAME* being replaced by another process
(with **--bus-name** and **--replace**). (with **--bus-name** and **--replace**).
64 (**EX_USAGE** from **sysexits.h**) 64 (`EX_USAGE` from `sysexits.h`)
: Invalid arguments were given. : Invalid arguments were given.
Other nonzero values Other nonzero values
......
...@@ -312,13 +312,13 @@ changed to be more like **env**(1) in future. ...@@ -312,13 +312,13 @@ changed to be more like **env**(1) in future.
: An error occurred while setting up the execution environment or : An error occurred while setting up the execution environment or
starting the *COMMAND* starting the *COMMAND*
64 (**EX_USAGE**) 64 (`EX_USAGE` from `sysexits.h`)
: Invalid arguments were given : Invalid arguments were given
69 (**EX_UNAVAILABLE**) 69 (`EX_UNAVAILABLE` from `sysexits.h`)
: An error occurred while setting up the execution environment : An error occurred while setting up the execution environment
75 (**EX_TEMPFAIL**) 75 (`EX_TEMPFAIL` from `sysexits.h`)
: A **--lock-file** could not be acquired, and **--wait** was not given : A **--lock-file** could not be acquired, and **--wait** was not given
126 126
......
...@@ -66,18 +66,18 @@ the output directory is empty (exit status 0), ...@@ -66,18 +66,18 @@ the output directory is empty (exit status 0),
: All necessary locales were already available without altering : All necessary locales were already available without altering
the **LOCPATH** environment variable. the **LOCPATH** environment variable.
64 (**EX_USAGE** from **sysexits.h**) 64 (`EX_USAGE` from `sysexits.h`)
: Invalid arguments were given. : Invalid arguments were given.
72 (**EX_OSFILE**) 72 (`EX_OSFILE` from `sysexits.h`)
: Not all of the necessary locales were already available, but all : Not all of the necessary locales were already available, but all
were generated in the output directory. were generated in the output directory.
73 (**EX_CANTCREAT**) 73 (`EX_CANTCREAT` from `sysexits.h`)
: At least one locale was not generated successfully. Some other : At least one locale was not generated successfully. Some other
locales might have been generated in the output directory as usual. locales might have been generated in the output directory as usual.
78 (**EX_CONFIG**) 78 (`EX_CONFIG` from `sysexits.h`)
: One of the locales given was invalid or could lead to path traversal. : One of the locales given was invalid or could lead to path traversal.
Other locales might have been generated as usual. Other locales might have been generated as usual.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment