aboutsummaryrefslogtreecommitdiffhomepage
path: root/devel/schemata
diff options
context:
space:
mode:
Diffstat (limited to 'devel/schemata')
-rw-r--r--devel/schemata8
1 files changed, 7 insertions, 1 deletions
diff --git a/devel/schemata b/devel/schemata
index e5c55050..d1ab983a 100644
--- a/devel/schemata
+++ b/devel/schemata
@@ -1,5 +1,5 @@
This file describes the schemata used for notmuch's structured output
-format (currently JSON).
+format (currently JSON and S-Expressions).
[]'s indicate lists. List items can be marked with a '?', meaning
they are optional; or a '*', meaning there can be zero or more of that
@@ -8,6 +8,12 @@ values. An object field marked '?' is optional. |'s indicate
alternates (e.g., int|string means something can be an int or a
string).
+For S-Expression output, lists are printed delimited by () instead of
+[]. Objects are printed as p-lists, i.e. lists where the keys and values
+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.
+
Common non-terminals
--------------------