[PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp description

diff --git a/19/55b9f2675f7c082f98057f9bc2b1966ed923bb b/19/55b9f2675f7c082f98057f9bc2b1966ed923bb
new file mode 100644 (file)
index 0000000..3b549cd
--- /dev/null
+++ b/19/55b9f2675f7c082f98057f9bc2b1966ed923bb
@@ -0,0 +1,111 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1EEE4431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:54 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id laosfe6yTfQy for <notmuch@notmuchmail.org>;\r
+       Fri, 18 Apr 2014 15:42:47 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu\r
+       [18.9.25.14])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 14AAE431FC0\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:24 -0700 (PDT)\r
+X-AuditID: 1209190e-f79ee6d000000c40-56-5351aa502363\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id BB.71.03136.05AA1535; Fri, 18 Apr 2014 18:42:24 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id s3IMgDDb007080; \r
+       Fri, 18 Apr 2014 18:42:13 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IMgBLX028753\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Fri, 18 Apr 2014 18:42:13 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1WbHU2-0007bN-TB; Fri, 18 Apr 2014 18:42:10 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp\r
+       description\r
+Date: Fri, 18 Apr 2014 18:42:08 -0400\r
+Message-Id: <1397860928-29032-5-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.9.1\r
+In-Reply-To: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
+References: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFlrPIsWRmVeSWpSXmKPExsUixCmqrBuwKjDY4ONUPovrN2cyOzB6PFt1\r
+       izmAMYrLJiU1J7MstUjfLoEr49rmc+wFp3gqnvUXNTD2c3YxcnJICJhINB7rZ4OwxSQu3FsP\r
+       ZHNxCAnMZpK4dfEyK4SzkVFi+e8mZpAqIYEjTBLLX6VCJOYySjTcP88IkmAT0JDYtn85mC0i\r
+       IC2x8+5soG4ODmYBNYk/XSogprBAhMT9pYkgFSwCqhKnph4Bq+YVcJA4N+8KC8QRchInj00G\r
+       6+QUcJS49k0IYquDRP/VxYwTGPkXMDKsYpRNya3SzU3MzClOTdYtTk7My0st0jXWy80s0UtN\r
+       Kd3ECA4XSb4djF8PKh1iFOBgVOLh3RAQGCzEmlhWXJl7iFGSg0lJlPfRYqAQX1J+SmVGYnFG\r
+       fFFpTmrxIUYJDmYlEd6rXUA53pTEyqrUonyYlDQHi5I471trq2AhgfTEktTs1NSC1CKYrAwH\r
+       h5IEb/ZKoEbBotT01Iq0zJwShDQTByfIcB6g4U9XgAwvLkjMLc5Mh8ifYlSUEuetAEkIgCQy\r
+       SvPgemHx/IpRHOgVYd4SkBU8wFQA1/0KaDAT0OC/ZwJABpckIqSkGhiX/zp/M3GS/J5W8cUV\r
+       J2u/z2fnWHIm9tpyh28bv4Zee3vdp6dP+XpGlplEwBTLs4c2T+q6ktzRe2Kj4o6eAuY5s891\r
+       F15JbLLI43kxl6Mq2eqU7LfLzOnGjGL+HNNlprDNziySO+Z2KpJxyZ07a3b8TRBj3X/COlx6\r
+       a8aqKfbfwqJ5BFe2OUsrsRRnJBpqMRcVJwIAJ/Of68ICAAA=\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 18 Apr 2014 22:42:54 -0000\r
+\r
+Previously, this was a verbatim copy of the --format=json text.\r
+Change it to instead reference the JSON text and actually describe how\r
+the S-expression format works.\r
+---\r
+ doc/man1/notmuch-show.rst | 14 ++++++--------\r
+ 1 file changed, 6 insertions(+), 8 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
+index 78196ee..5aecbfd 100644\r
+--- a/doc/man1/notmuch-show.rst\r
++++ b/doc/man1/notmuch-show.rst\r
+@@ -57,14 +57,12 @@ Supported options for **show** include\r
+             UTF-8.\r
+ \r
+         **sexp**\r
+-            The output is formatted as an S-Expression (sexp). This\r
+-            format is more robust than the text format for automated\r
+-            processing. The nested structure of multipart MIME messages\r
+-            is reflected in nested S-Expression output. By default,\r
+-            S-Expression output includes all messages in a matching\r
+-            thread; that is, by default,\r
+-            ``--format=sexp`` sets ``--entire-thread``. The caller can\r
+-            disable this behaviour by setting ``--entire-thread=false``.\r
++            The output is formatted as the Lisp s-expression (sexp)\r
++            equivalent of the JSON format above. Objects are formatted\r
++            as property lists whose keys are keywords (symbols preceded\r
++            by a colon). True is formatted as ``t`` and both false and\r
++            null are formatted as ``nil``. As for JSON, the s-expression\r
++            output is always encoded as UTF-8.\r
+ \r
+         **mbox**\r
+             All matching messages are output in the traditional, Unix\r
+-- \r
+1.9.1\r
+\r