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