From: Austin Clements <amdragon@MIT.EDU>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp
	description
Date: Fri, 18 Apr 2014 18:42:08 -0400
Message-Id: <1397860928-29032-5-git-send-email-amdragon@mit.edu>
In-Reply-To: <1397860928-29032-1-git-send-email-amdragon@mit.edu>
References: <1397860928-29032-1-git-send-email-amdragon@mit.edu>
Precedence: list

Previously, this was a verbatim copy of the --format=json text.
Change it to instead reference the JSON text and actually describe how
the S-expression format works.
---
 doc/man1/notmuch-show.rst | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst
index 78196ee..5aecbfd 100644
--- a/doc/man1/notmuch-show.rst
+++ b/doc/man1/notmuch-show.rst
@@ -57,14 +57,12 @@ Supported options for **show** include
             UTF-8.
 
         **sexp**
-            The output is formatted as an S-Expression (sexp). This
-            format is more robust than the text format for automated
-            processing. The nested structure of multipart MIME messages
-            is reflected in nested S-Expression output. By default,
-            S-Expression output includes all messages in a matching
-            thread; that is, by default,
-            ``--format=sexp`` sets ``--entire-thread``. The caller can
-            disable this behaviour by setting ``--entire-thread=false``.
+            The output is formatted as the Lisp s-expression (sexp)
+            equivalent of the JSON format above. Objects are formatted
+            as property lists whose keys are keywords (symbols preceded
+            by a colon). True is formatted as ``t`` and both false and
+            null are formatted as ``nil``. As for JSON, the s-expression
+            output is always encoded as UTF-8.
 
         **mbox**
             All matching messages are output in the traditional, Unix
-- 
1.9.1