summaryrefslogtreecommitdiff
path: root/metastore.txt
diff options
context:
space:
mode:
authorAdam Spragg <adam@spra.gg>2022-05-23 15:29:11 +0100
committerAdam Spragg <adam@spra.gg>2022-05-24 10:12:33 +0100
commita0902fe51010645f779e4d02cd46f35e488b8bd2 (patch)
treec741aea22bae668fee418b8ac0938bdbc96675c6 /metastore.txt
parent7c0520451b071e77b4c432ed89fc7559b8c58138 (diff)
Return non-zero exit status if "compare" finds differences
This makes `metastore` more useful in scripts, just to check if it found anything, in the same way as `diff` and `grep`. Note that POSIX requires that EXIT_SUCCESS is 0, and EXIT_FAILURE is 1, so I've defined EXIT_DIFFERENCES as 2 which, while different from the values `diff` and `grep` use (1 for finding something, 2 for errors), maintains a certain amount of backwards compatibility with previous versions of metastore.
Diffstat (limited to 'metastore.txt')
-rw-r--r--metastore.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/metastore.txt b/metastore.txt
index 351ccc4..691fea5 100644
--- a/metastore.txt
+++ b/metastore.txt
@@ -87,6 +87,11 @@ PATHS
will each be examined. Later invocations should be made using the exact
same paths to ensure that the stored metadata is interpreted correctly.
+EXIT STATUS
+ metastore returns an exit status of 0 on success, or 1 if an error oc‐
+ curred. If the compare action is selected and differences are found,
+ the exit status is 2.
+
FORMATS
0 The original and default format, it is a compact binary repre‐
sentation of the file metadata stored.