Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description
authorAustin Clements <amdragon@MIT.EDU>
Fri, 18 Apr 2014 19:33:15 +0000 (15:33 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:43 +0000 (10:01 -0800)
a5/0d30ff0a2758739e7b32c277f436b199255fc7 [new file with mode: 0644]

diff --git a/a5/0d30ff0a2758739e7b32c277f436b199255fc7 b/a5/0d30ff0a2758739e7b32c277f436b199255fc7
new file mode 100644 (file)
index 0000000..bf6565e
--- /dev/null
@@ -0,0 +1,155 @@
+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 49107431FB6\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:33:46 -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 sIFQIaWDsvwG for <notmuch@notmuchmail.org>;\r
+       Fri, 18 Apr 2014 12:33:21 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id D59CF431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:33:20 -0700 (PDT)\r
+X-AuditID: 12074422-f79186d00000135a-c5-53517e00d78f\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id BF.21.04954.00E71535; Fri, 18 Apr 2014 15:33:20 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id s3IJXI2V021022; \r
+       Fri, 18 Apr 2014 15:33:20 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\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 s3IJXGvQ028487\r
+       (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT);\r
+       Fri, 18 Apr 2014 15:33:18 -0400\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.80)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1WbEXE-0003PB-7W; Fri, 18 Apr 2014 15:33:16 -0400\r
+Date: Fri, 18 Apr 2014 15:33:15 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description\r
+Message-ID: <20140418193315.GB9395@mit.edu>\r
+References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+       <1397834332-25175-2-git-send-email-amdragon@mit.edu>\r
+       <87lhv2h26m.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <87lhv2h26m.fsf@qmul.ac.uk>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFmpmleLIzCtJLcpLzFFi42IRYrdT0WWoCww2OLFe0GL1XB6L6zdnMjsw\r
+       eeycdZfd49mqW8wBTFFcNimpOZllqUX6dglcGZu2XGMq2CxdMXvqIfYGxv3CXYycHBICJhJL\r
+       /k9lg7DFJC7cWw9kc3EICcxmktg6eQ0rhLORUeLDzf/MEM5pJomJPfuhnCWMEs9//mIH6WcR\r
+       UJW4em4lE4jNJqAhsW3/ckYQW0RAR+L2oQVgNcwC0hLffjeD1QgLeEusbdnNCmLzCmhLLPi8\r
+       gQVi6FRGif+XJjNCJAQlTs58wgLRrCVx499LoGYOsEHL/3GAmJxAuw5+dwWpEBVQkZhychvb\r
+       BEahWUiaZyFpnoXQvICReRWjbEpulW5uYmZOcWqybnFyYl5eapGuqV5uZoleakrpJkZwWLso\r
+       7WD8eVDpEKMAB6MSD++GgMBgIdbEsuLK3EOMkhxMSqK8cyuBQnxJ+SmVGYnFGfFFpTmpxYcY\r
+       JTiYlUR45/sC5XhTEiurUovyYVLSHCxK4rxvra2ChQTSE0tSs1NTC1KLYLIyHBxKErzFtUCN\r
+       gkWp6akVaZk5JQhpJg5OkOE8QMPLQGp4iwsSc4sz0yHypxgVpcR5b9UAJQRAEhmleXC9sLTz\r
+       ilEc6BVhXhuQdh5gyoLrfgU0mAlo8N8zASCDSxIRUlINjHUZHwKF4xVbTrNsmib3buW0gAxD\r
+       EYlvSae3z4idw3vw/guG0JP15/sKJAVtUxb6/t76J3diVUHo9s+e0jN/uYWW3Pn9MXjVKoO9\r
+       m72nBYSJ1iU7Pb8V/tN4954Fk5zsHvisWaof8aS/bPYr7YWvjfKKzm49vYa35N9epm0dc1KF\r
+       YzjDFn5fq6LEUpyRaKjFXFScCACk4WFsFgMAAA==\r
+Cc: notmuch@notmuchmail.org\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 19:33:46 -0000\r
+\r
+Quoth Mark Walters on Apr 18 at  8:23 pm:\r
+> \r
+> On Fri, 18 Apr 2014, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> > In addition to being generally more precise, this is explicit that\r
+> > there is no charset conversion.\r
+> > ---\r
+> >  doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++----------------\r
+> >  1 file changed, 20 insertions(+), 16 deletions(-)\r
+> >\r
+> > diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
+> > index bad868b..2c0f64c 100644\r
+> > --- a/doc/man1/notmuch-show.rst\r
+> > +++ b/doc/man1/notmuch-show.rst\r
+> > @@ -76,22 +76,26 @@ Supported options for **show** include\r
+> >  \r
+> >        http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\r
+> >  \r
+> > -        **raw** (default for a single part, see --part)\r
+> > -            For a message or an attached message part, the original, raw\r
+> > -            content of the email message is output. Consumers of this\r
+> > -            format should expect to implement MIME decoding and similar\r
+> > -            functions.\r
+> > -\r
+> > -            For a single part (--part) the raw part content is output\r
+> > -            after performing any necessary MIME decoding. Note that\r
+> > -            messages with a simple body still have two parts: part 0 is\r
+> > -            the whole message and part 1 is the body.\r
+> > -\r
+> > -            For a multipart part, the part headers and body (including\r
+> > -            all child parts) is output.\r
+> > -\r
+> > -            The raw format must only be used with search terms matching\r
+> > -            single message.\r
+> > +        **raw** (default if --part is given)\r
+> > +            Write the raw bytes of the given MIME part of a message to\r
+> > +            standard out. For this format, it is an error to specify a\r
+> > +            query that matches more than one message.\r
+> > +\r
+> > +            If the specified part is a leaf part, this outputs the\r
+> > +            body of the part after performing content transfer\r
+> > +            decoding (but no charset conversion). This is suitable for\r
+> > +            saving attachments, for example.\r
+> > +\r
+> > +            For a multipart or message part, the output includes the\r
+> > +            part headers as well as the body (including all child\r
+> > +            parts). No decoding is performed because multipart and\r
+> > +            message parts cannot have non-trivial content transfer\r
+> > +            encoding. Consumers of this may need to implement MIME\r
+> > +            decoding and similar functions.\r
+> > +\r
+> > +            Note that even a message with a simple body has two parts:\r
+> > +            part 0 is the whole message and part 1 is the body of the\r
+> > +            message.\r
+> \r
+> Generally this looks good. I wonder whether the paragraph above could be\r
+> expanded slightly: my (quite possibly flawed) understanding is that\r
+> simple messages don't need to be MIME encoded (at least some messages\r
+> don't contain any mention of MIME). If this is correct then I think it\r
+> would be worth clarifying that this paragraph applies even to non-MIME\r
+> encoded messages.\r
+\r
+It's true that even "non-MIME" messages have two MIME parts.  Are you\r
+thinking something like\r
+\r
+Note that even a message with no MIME structure or a single body part\r
+still has two MIME parts: part 0 is the whole message (headers and\r
+body) and part 1 is just the body.\r
+\r
+?\r
+\r
+I wonder if this would be better in the documentation for --part.\r
+\r
+> Best wishes\r
+> \r
+> Mark\r