3f/5dc836338ac25480d4bf0b567a0fa88ec699d2

   1 Return-Path: <amdragon@mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 8567C431FC0\r
   6         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:20 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id 1V4O6WXJCCR4 for <notmuch@notmuchmail.org>;\r
  16         Fri, 18 Apr 2014 08:19:15 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu\r
  18         [18.9.25.14])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 30507431FB6\r
  22         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:11 -0700 (PDT)\r
  23 X-AuditID: 1209190e-f79ee6d000000c40-64-5351426ef994\r
  24 Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
  25         (using TLS with cipher AES256-SHA (256/256 bits))\r
  26         (Client did not present a certificate)\r
  27         by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
  28         id F2.69.03136.E6241535; Fri, 18 Apr 2014 11:19:10 -0400 (EDT)\r
  29 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  30         by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s3IFIxmT021240; \r
  31         Fri, 18 Apr 2014 11:18:59 -0400\r
  32 Received: from drake.dyndns.org\r
  33         (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  34         [216.15.114.40]) (authenticated bits=0)\r
  35         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  36         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IFIvCp027513\r
  37         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  38         Fri, 18 Apr 2014 11:18:58 -0400\r
  39 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  40         (envelope-from <amdragon@mit.edu>)\r
  41         id 1WbAZ7-0006bB-3e; Fri, 18 Apr 2014 11:18:57 -0400\r
  42 From: Austin Clements <amdragon@MIT.EDU>\r
  43 To: notmuch@notmuchmail.org\r
  44 Subject: [PATCH 4/4] doc: Simplify and clarify notmuch show --format=sexp\r
  45         description\r
  46 Date: Fri, 18 Apr 2014 11:18:52 -0400\r
  47 Message-Id: <1397834332-25175-5-git-send-email-amdragon@mit.edu>\r
  48 X-Mailer: git-send-email 1.9.1\r
  49 In-Reply-To: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
  50 References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
  51 X-Brightmail-Tracker:\r
  52  H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqrZvnFBhsMPu9pcX1mzOZHRg9nq26\r
  53         xRzAGMVlk5Kak1mWWqRvl8CV8WxGF3vBKZ6KZxNWsTUw9nN2MXJwSAiYSJx5aNbFyAlkiklc\r
  54         uLeerYuRi0NIYDaTxO3fV5khnI2MEv/6+lghnDtMEv2/LzFBOHMZJZbuvsUO0s8moCGxbf9y\r
  55         RhBbREBaYufd2awgK5gF1CT+dKmAmMICoRIPblaDVLAIqEosbP/PDGLzCjhIrJ39khniCjmJ\r
  56         k8cms4LYnAKOEi+Xt7CA2EJANc9fnWWawMi/gJFhFaNsSm6Vbm5iZk5xarJucXJiXl5qka6x\r
  57         Xm5miV5qSukmRnDISPLtYPx6UOkQowAHoxIPbyRzYLAQa2JZcWXuIUZJDiYlUd4KG6AQX1J+\r
  58         SmVGYnFGfFFpTmrxIUYJDmYlEd7dfwOChXhTEiurUovyYVLSHCxK4rxvra2ChQTSE0tSs1NT\r
  59         C1KLYLIyHBxKErzVjkBDBYtS01Mr0jJzShDSTBycIMN5gIYngNTwFhck5hZnpkPkTzEqSonz\r
  60         5jkAJQRAEhmleXC9sJh+xSgO9Iow73SQdh5gOoDrfgU0mAlo8N8zIFcXlyQipKQaGDe9jBWN\r
  61         +q5XVmm5+1Xs0oNq75++VeJX8XBZcH5vxFVGvoYXAZLi26d4z+0pOdBYyt68wuH4T84HzAFJ\r
  62         0RWqBqVKKranxTwnacnrvdlfHqwYrn/vTpmd45NdwZIyV9m1blQenz8l2u1PUPG8p7ouLx+0\r
  63         JixkfL7yWDgHw8s8o517kkPiV7VsU2Ipzkg01GIuKk4EAIR0HXnEAgAA\r
  64 X-BeenThere: notmuch@notmuchmail.org\r
  65 X-Mailman-Version: 2.1.13\r
  66 Precedence: list\r
  67 List-Id: "Use and development of the notmuch mail system."\r
  68         <notmuch.notmuchmail.org>\r
  69 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  70         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  71 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  72 List-Post: <mailto:notmuch@notmuchmail.org>\r
  73 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  74 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  75         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  76 X-List-Received-Date: Fri, 18 Apr 2014 15:19:20 -0000\r
  77 \r
  78 Previously, this was a verbatim copy of the --format=json text.\r
  79 Change it to instead reference the JSON text and actually describe how\r
  80 the S-expression format works.\r
  81 ---\r
  82  doc/man1/notmuch-show.rst | 14 ++++++--------\r
  83  1 file changed, 6 insertions(+), 8 deletions(-)\r
  84 \r
  85 diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
  86 index b8b10b9..586dbc5 100644\r
  87 --- a/doc/man1/notmuch-show.rst\r
  88 +++ b/doc/man1/notmuch-show.rst\r
  89 @@ -57,14 +57,12 @@ Supported options for **show** include\r
  90              UTF-8.\r
  91  \r
  92          **sexp**\r
  93 -            The output is formatted as an S-Expression (sexp). This\r
  94 -            format is more robust than the text format for automated\r
  95 -            processing. The nested structure of multipart MIME messages\r
  96 -            is reflected in nested S-Expression output. By default,\r
  97 -            S-Expression output includes all messages in a matching\r
  98 -            thread; that is, by default,\r
  99 -            ``--format=sexp`` sets ``--entire-thread``. The caller can\r
 100 -            disable this behaviour by setting ``--entire-thread=false``.\r
 101 +            The output is formatted as the Lisp s-expression (sexp)\r
 102 +            equivalent of the JSON format above. Objects are formatted\r
 103 +            as property lists whose keys are keywords (symbols preceded\r
 104 +            by a colon). True is formatted as ``t`` and both false and\r
 105 +            null are formatted as ``nil``. As for JSON, the s-expression\r
 106 +            output is always encoded as UTF-8.\r
 107  \r
 108          **mbox**\r
 109              All matching messages are output in the traditional, Unix\r
 110 -- \r
 111 1.9.1\r
 112 \r