summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version-check.1.asciidoc
diff options
context:
space:
mode:
authorLevente Polyak <anthraxx@archlinux.org>2024-01-18 19:15:22 +0100
committerLevente Polyak <anthraxx@archlinux.org>2024-01-22 19:45:10 +0100
commite3edf25554c78e28679b100e24c55c87ee65a22d (patch)
treeb630bf07cc736fe986140154bb8f576e62afe9d4 /doc/man/pkgctl-version-check.1.asciidoc
parentb258bb3b7c55d06bad108400450acd32cff05366 (diff)
downloaddevtools-e3edf25554c78e28679b100e24c55c87ee65a22d.tar.xz
feat(version): use exit code for check to indicate out-of-date versions
It can be handy to have an exit code that allows better status indication or chaining. On exit, return one of the following codes: - 0: Normal exit condition, all checked versions are up-to-date - 1: Unknown cause of failure - 2: Normal exit condition, but there are out-of-date versions - 3: Failed to run some version checks Component: pkgctl version check Signed-off-by: Levente Polyak <anthraxx@archlinux.org>
Diffstat (limited to 'doc/man/pkgctl-version-check.1.asciidoc')
-rw-r--r--doc/man/pkgctl-version-check.1.asciidoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/pkgctl-version-check.1.asciidoc b/doc/man/pkgctl-version-check.1.asciidoc
index 3113afa..fa5401f 100644
--- a/doc/man/pkgctl-version-check.1.asciidoc
+++ b/doc/man/pkgctl-version-check.1.asciidoc
@@ -36,6 +36,23 @@ Options
*-h, --help*::
Show a help text
+Errors
+------
+
+On exit, return one of the following codes:
+
+*0*::
+ Normal exit condition, all checked versions are up-to-date
+
+*1*::
+ Unknown cause of failure
+
+*2*::
+ Normal exit condition, but there are out-of-date versions
+
+*3*::
+ Failed to run some version checks
+
See Also
--------