Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description
authorMark Walters <markwalters1009@gmail.com>
Fri, 18 Apr 2014 19:23:29 +0000 (20:23 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:43 +0000 (10:01 -0800)
01/5d71defb7efb5adfda3dca179c9f810715b6a7 [new file with mode: 0644]

diff --git a/01/5d71defb7efb5adfda3dca179c9f810715b6a7 b/01/5d71defb7efb5adfda3dca179c9f810715b6a7
new file mode 100644 (file)
index 0000000..cb13b0b
--- /dev/null
@@ -0,0 +1,146 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 D6D03431FB6\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:23:57 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 QS+epAFk+cSY for <notmuch@notmuchmail.org>;\r
+       Fri, 18 Apr 2014 12:23:48 -0700 (PDT)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\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 0CA22431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:23:47 -0700 (PDT)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1WbENv-0006er-U2; Fri, 18 Apr 2014 20:23:42 +0100\r
+Received: from 94.196.126.238.threembb.co.uk ([94.196.126.238] helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1WbENu-0001Mx-Gw; Fri, 18 Apr 2014 20:23:39 +0100\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Austin Clements <amdragon@MIT.EDU>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description\r
+In-Reply-To: <1397834332-25175-2-git-send-email-amdragon@mit.edu>\r
+References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+       <1397834332-25175-2-git-send-email-amdragon@mit.edu>\r
+User-Agent: Notmuch/0.15.2+615~g78e3a93 (http://notmuchmail.org) Emacs/23.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Fri, 18 Apr 2014 20:23:29 +0100\r
+Message-ID: <87lhv2h26m.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 94.196.126.238\r
+X-QM-Geographic: According to ripencc,\r
+       this message was delivered by a machine in Britain (UK) (GB).\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: e36223e3c6ba0d2ff1b732c0c6ce3690 (of first 20000 bytes)\r
+X-SpamAssassin-Score: 0.0\r
+X-SpamAssassin-SpamBar: /\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored 0.0 points. Summary of the scoring: \r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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:23:58 -0000\r
+\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
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+>  \r
+>      ``--format-version=N``\r
+>          Use the specified structured output format version. This is\r
+> -- \r
+> 1.9.1\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r