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

diff --git a/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2 b/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2
new file mode 100644 (file)
index 0000000..808b29c
--- /dev/null
+++ b/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2
@@ -0,0 +1,112 @@
+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 8567C431FC0\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:20 -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 1V4O6WXJCCR4 for <notmuch@notmuchmail.org>;\r
+       Fri, 18 Apr 2014 08:19:15 -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 30507431FB6\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:11 -0700 (PDT)\r
+X-AuditID: 1209190e-f79ee6d000000c40-64-5351426ef994\r
+Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\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 F2.69.03136.E6241535; Fri, 18 Apr 2014 11:19:10 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s3IFIxmT021240; \r
+       Fri, 18 Apr 2014 11:18:59 -0400\r
+Received: from drake.dyndns.org\r
+       (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [216.15.114.40]) (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 s3IFIvCp027513\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Fri, 18 Apr 2014 11:18:58 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1WbAZ7-0006bB-3e; Fri, 18 Apr 2014 11:18:57 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 4/4] doc: Simplify and clarify notmuch show --format=sexp\r
+       description\r
+Date: Fri, 18 Apr 2014 11:18:52 -0400\r
+Message-Id: <1397834332-25175-5-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.9.1\r
+In-Reply-To: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqrZvnFBhsMPu9pcX1mzOZHRg9nq26\r
+       xRzAGMVlk5Kak1mWWqRvl8CV8WxGF3vBKZ6KZxNWsTUw9nN2MXJwSAiYSJx5aNbFyAlkiklc\r
+       uLeerYuRi0NIYDaTxO3fV5khnI2MEv/6+lghnDtMEv2/LzFBOHMZJZbuvsUO0s8moCGxbf9y\r
+       RhBbREBaYufd2awgK5gF1CT+dKmAmMICoRIPblaDVLAIqEosbP/PDGLzCjhIrJ39khniCjmJ\r
+       k8cms4LYnAKOEi+Xt7CA2EJANc9fnWWawMi/gJFhFaNsSm6Vbm5iZk5xarJucXJiXl5qka6x\r
+       Xm5miV5qSukmRnDISPLtYPx6UOkQowAHoxIPbyRzYLAQa2JZcWXuIUZJDiYlUd4KG6AQX1J+\r
+       SmVGYnFGfFFpTmrxIUYJDmYlEd7dfwOChXhTEiurUovyYVLSHCxK4rxvra2ChQTSE0tSs1NT\r
+       C1KLYLIyHBxKErzVjkBDBYtS01Mr0jJzShDSTBycIMN5gIYngNTwFhck5hZnpkPkTzEqSonz\r
+       5jkAJQRAEhmleXC9sJh+xSgO9Iow73SQdh5gOoDrfgU0mAlo8N8zIFcXlyQipKQaGDe9jBWN\r
+       +q5XVmm5+1Xs0oNq75++VeJX8XBZcH5vxFVGvoYXAZLi26d4z+0pOdBYyt68wuH4T84HzAFJ\r
+       0RWqBqVKKranxTwnacnrvdlfHqwYrn/vTpmd45NdwZIyV9m1blQenz8l2u1PUPG8p7ouLx+0\r
+       JixkfL7yWDgHw8s8o517kkPiV7VsU2Ipzkg01GIuKk4EAIR0HXnEAgAA\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 15:19:20 -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 b8b10b9..586dbc5 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