From: Austin Clements Date: Wed, 25 Jul 2012 03:12:02 +0000 (+2000) Subject: Re: [PATCH v2] man: show: update man page for entire-thread and json. X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=8ea3960fe26674c463b5264b3231e2eba8235217;p=notmuch-archives.git Re: [PATCH v2] man: show: update man page for entire-thread and json. --- diff --git a/e3/21a943be590d31312f8ad4858bc5e94c5583c4 b/e3/21a943be590d31312f8ad4858bc5e94c5583c4 new file mode 100644 index 000000000..cbf8f5a0b --- /dev/null +++ b/e3/21a943be590d31312f8ad4858bc5e94c5583c4 @@ -0,0 +1,137 @@ +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 1D56A431FC7 + for ; Tue, 24 Jul 2012 20:12:07 -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 W-j-pgVNTyuu for ; + Tue, 24 Jul 2012 20:12:04 -0700 (PDT) +Received: from dmz-mailsec-scanner-3.mit.edu (DMZ-MAILSEC-SCANNER-3.MIT.EDU + [18.9.25.14]) + by olra.theworths.org (Postfix) with ESMTP id B5EE3431FAF + for ; Tue, 24 Jul 2012 20:12:04 -0700 (PDT) +X-AuditID: 1209190e-b7fb56d0000008b2-c9-500f6404c267 +Received: from mailhub-auth-4.mit.edu ( [18.7.62.39]) + by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP + id F9.30.02226.4046F005; Tue, 24 Jul 2012 23:12:04 -0400 (EDT) +Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) + by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q6P3C44T011356; + Tue, 24 Jul 2012 23:12:04 -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.6/8.12.4) with ESMTP id q6P3C2nV029104 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Tue, 24 Jul 2012 23:12:03 -0400 (EDT) +Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77) + (envelope-from ) + id 1Sts14-0007gZ-Md; Tue, 24 Jul 2012 23:12:02 -0400 +From: Austin Clements +To: Mark Walters , notmuch@notmuchmail.org +Subject: Re: [PATCH v2] man: show: update man page for entire-thread and json. +In-Reply-To: <1343156277-28146-1-git-send-email-markwalters1009@gmail.com> +References: <20120722163628.GE31834@mit.edu> + <1343156277-28146-1-git-send-email-markwalters1009@gmail.com> +User-Agent: Notmuch/0.13.2+59~g78b98ba (http://notmuchmail.org) Emacs/23.3.1 + (i486-pc-linux-gnu) +Date: Tue, 24 Jul 2012 23:12:02 -0400 +Message-ID: <87r4s0pm9p.fsf@awakening.csail.mit.edu> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFrrHIsWRmVeSWpSXmKPExsUixG6nrsuSwh9gcPiIiMXquTwW12/OZHZg + 8tg56y67x7NVt5gDmKK4bFJSczLLUov07RK4MvbcP8dWcI+/4tfh5SwNjKd5uhg5OSQETCSW + 7+hkhrDFJC7cW88GYgsJ7GOU6D+V2cXIBWRvYJT4fGEhO4Rzkkli6dnXUM4SRomtxzeBtbMJ + aEhs27+cEcQWEXCVePrtM1Ccg0NYwE9i+jNhkDCngJfExeszGSE2ZEnc2/eJEaREVCBB4uDx + GpAwi4CqxLnW16wgNi/QcdsezWaHsAUlTs58wgJiMwtoSdz495JpAqPALCSpWUhSCxiZVjHK + puRW6eYmZuYUpybrFicn5uWlFuka6+VmluilppRuYgQFI6ck3w7GrweVDjEKcDAq8fD+fsIX + IMSaWFZcmXuIUZKDSUmUlyuJP0CILyk/pTIjsTgjvqg0J7X4EKMEB7OSCG9RGFCONyWxsiq1 + KB8mJc3BoiTOeyXlpr+QQHpiSWp2ampBahFMVoaDQ0mC1zIZqFGwKDU9tSItM6cEIc3EwQky + nAdouA5IDW9xQWJucWY6RP4Uo6KUOG8ISEIAJJFRmgfXC0sWrxjFgV4R5tUHqeIBJhq47ldA + g5mABj8P4wMZXJKIkJJqYEydHPvT+Zfy7B3dn2JU1uu8MJjwReV8qtgOKfd+wZNbmKUiKwJt + KqYKvNAOF0k9sqE8oOdj80Jr1+Sd7HKss/+pCfgqHzQtMXvou3Rpou7TnDevT03QeHvirO0r + w/fWUuYJtY2nNk+conVX+cXHs59O/trOsrhGZ5L3I5GDbhuvxScvSmA7x6zEUpyRaKjFXFSc + CAC/55Id8QIAAA== +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: Wed, 25 Jul 2012 03:12:07 -0000 + +LGTM. + +On Tue, 24 Jul 2012, Mark Walters wrote: +> Previously in notmuch show --format=json implied --entire-thread. This +> is still the default but it is now possible to disable this. Update +> the manpage to reflect this. +> --- +> +> Update the manpage since --format=json and --entire-thread=false is +> now supported. Reworded as Austin suggested. +> +> Best wishes +> +> Mark +> +> man/man1/notmuch-show.1 | 21 +++++++++++++-------- +> 1 files changed, 13 insertions(+), 8 deletions(-) +> +> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 +> index 506583a..765b22c 100644 +> --- a/man/man1/notmuch-show.1 +> +++ b/man/man1/notmuch-show.1 +> @@ -24,11 +24,14 @@ Supported options for +> include +> .RS 4 +> .TP 4 +> -.B \-\-entire\-thread +> +.B \-\-entire\-thread=(true|false) +> +> -By default only those messages that match the search terms will be +> -displayed. With this option, all messages in the same thread as any +> -matched message will be displayed. +> +If true, +> +.B notmuch show +> +outputs all messages in the thread of any message matching the search +> +terms; if false, it outputs only the matching messages. For +> +.B --format=json +> +this defaults to true. For other formats, this defaults to false. +> .RE +> +> .RS 4 +> @@ -55,11 +58,13 @@ be nested. +> The output is formatted with Javascript Object Notation (JSON). This +> format is more robust than the text format for automated +> processing. The nested structure of multipart MIME messages is +> -reflected in nested JSON output. JSON output always includes all +> -messages in a matching thread; in effect +> +reflected in nested JSON output. By default JSON output includes all +> +messages in a matching thread; that is, by default, +> .B \-\-format=json +> -implies +> -.B \-\-entire\-thread +> +sets +> +.B "\-\-entire\-thread" +> +The caller can disable this behaviour by setting +> +.B \-\-entire\-thread=false +> +> .RE +> .RS 4 +> -- +> 1.7.9.1