From a31e16f4a28e9695ee517df1d0fe86e3424af0b2 Mon Sep 17 00:00:00 2001
From: Simon McVittie <smcv@collabora.com>
Date: Thu, 28 Nov 2024 12:49:44 +0000
Subject: [PATCH] docs: Improve consistency of how we document sysexits.h
 status codes

Signed-off-by: Simon McVittie <smcv@collabora.com>
---
 bin/check-requirements.md       | 5 ++---
 bin/identify-library-abi.md     | 4 ++--
 bin/launcher-service.md         | 2 +-
 pressure-vessel/adverb.1.md     | 6 +++---
 pressure-vessel/locale-gen.1.md | 8 ++++----
 5 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/bin/check-requirements.md b/bin/check-requirements.md
index d48bcb562..599fccadc 100644
--- a/bin/check-requirements.md
+++ b/bin/check-requirements.md
@@ -44,9 +44,8 @@ Unstructured diagnostic messages appear on standard error.
 :   **steam-runtime-check-requirements** ran successfully and all the Steam
     client requirements are met.
 
-71
-:   At least one of the requirements is not met. In this case the exit status
-    will be 71 (EX_OSERR).
+71 (`EX_OSERR` from `sysexits.h`)
+:   At least one of the requirements is not met.
 
 Other Nonzero
 :   An error occurred.
diff --git a/bin/identify-library-abi.md b/bin/identify-library-abi.md
index 9cbc44285..d22a05058 100644
--- a/bin/identify-library-abi.md
+++ b/bin/identify-library-abi.md
@@ -60,8 +60,8 @@ the `LD_LIBRARY_PATH` Steam Runtime) but unsuitable for more general uses.
 0
 :   Success.
 
-64
-:   Invalid arguments were given (EX_USAGE).
+64 (`EX_USAGE` from `sysexits.h`)
+:   Invalid arguments were given.
 
 Other Nonzero
 :   An error occurred.
diff --git a/bin/launcher-service.md b/bin/launcher-service.md
index 66f3c278c..35b7cc483 100644
--- a/bin/launcher-service.md
+++ b/bin/launcher-service.md
@@ -300,7 +300,7 @@ inherits standard error.
     or by *NAME* being replaced by another process
     (with **--bus-name** and **--replace**).
 
-64 (**EX_USAGE** from **sysexits.h**)
+64 (`EX_USAGE` from `sysexits.h`)
 :   Invalid arguments were given.
 
 Other nonzero values
diff --git a/pressure-vessel/adverb.1.md b/pressure-vessel/adverb.1.md
index 4463ebeaa..5b1a71e8e 100644
--- a/pressure-vessel/adverb.1.md
+++ b/pressure-vessel/adverb.1.md
@@ -312,13 +312,13 @@ changed to be more like **env**(1) in future.
 :   An error occurred while setting up the execution environment or
     starting the *COMMAND*
 
-64 (**EX_USAGE**)
+64 (`EX_USAGE` from `sysexits.h`)
 :   Invalid arguments were given
 
-69 (**EX_UNAVAILABLE**)
+69 (`EX_UNAVAILABLE` from `sysexits.h`)
 :   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
 
 126
diff --git a/pressure-vessel/locale-gen.1.md b/pressure-vessel/locale-gen.1.md
index 973e9989e..207876d60 100644
--- a/pressure-vessel/locale-gen.1.md
+++ b/pressure-vessel/locale-gen.1.md
@@ -66,18 +66,18 @@ the output directory is empty (exit status 0),
 :   All necessary locales were already available without altering
     the **LOCPATH** environment variable.
 
-64 (**EX_USAGE** from **sysexits.h**)
+64 (`EX_USAGE` from `sysexits.h`)
 :   Invalid arguments were given.
 
-72 (**EX_OSFILE**)
+72 (`EX_OSFILE` from `sysexits.h`)
 :   Not all of the necessary locales were already available, but all
     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
     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.
     Other locales might have been generated as usual.
 
-- 
GitLab