aboutsummaryrefslogtreecommitdiffhomepage
path: root/devel
diff options
context:
space:
mode:
authorGravatar Austin Clements <amdragon@MIT.EDU>2012-12-15 22:17:23 -0500
committerGravatar David Bremner <bremner@debian.org>2012-12-16 17:20:33 -0400
commit1c6195b9e35e511e115f94b45d97aa58ee41b307 (patch)
treeb51eed0180afeb9d78523436841262a9f2795492 /devel
parent1e12b91b3cf823d21f7edf8c0f1c687df56fec14 (diff)
cli: Framework for structured output versioning
Currently there is a period of pain whenever we make backward-incompatible changes to the structured output format, which discourages not only backward-incompatible improvements to the format, but also backwards-compatible additions that may not be "perfect". In the end, these problems limit experimentation and innovation. This series of patches introduces a way for CLI callers to request a specific format version on the command line and to determine if the CLI does not supported the requested version (and perhaps present a useful diagnostic to the user). Since the caller requests a format version, it's also possible for the CLI to support multiple incompatible versions simultaneously, unlike the alternate approach of including version information in the output. This patch lays the groundwork by introducing a versioning convention, standard exit codes, and a utility function to check the requested version and produce standardized diagnostic messages and exit statuses.
Diffstat (limited to 'devel')
-rw-r--r--devel/schemata2
1 files changed, 2 insertions, 0 deletions
diff --git a/devel/schemata b/devel/schemata
index d1ab983a..292f2876 100644
--- a/devel/schemata
+++ b/devel/schemata
@@ -14,6 +14,8 @@ are interleaved. Keys are printed as keywords (symbols preceded by a
colon), e.g. (:id "123" :time 54321 :from "foobar"). Null is printed as
nil, true as t and false as nil.
+This is version 1 of the structured output format.
+
Common non-terminals
--------------------