Date: Sun, 22 Jul 2012 12:36:28 -0400
From: Austin Clements <amdragon@MIT.EDU>
To: Mark Walters <markwalters1009@gmail.com>
Subject: Re: [PATCH] man: show: update man page for entire-thread and json.
Message-ID: <20120722163628.GE31834@mit.edu>
References: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>
User-Agent: Mutt/1.5.21 (2010-09-15)
Cc: notmuch@notmuchmail.org
Precedence: list

Quoth Mark Walters on Jul 21 at  7:34 am:
> 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.
> ---
> 
> I didn't update the manpage in the recent patch series. This corrects
> that omission. (Less cumbersome wording gratefully received)
> 
> Best wishes
>                                                                                                                              
> Mark    man/man1/notmuch-show.1 |   16 +++++++++-------
>  1 files changed, 9 insertions(+), 7 deletions(-)
> 
> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
> index b51a54c..5fa590e 100644
> --- a/man/man1/notmuch-show.1
> +++ b/man/man1/notmuch-show.1
> @@ -26,9 +26,9 @@ include
>  .TP 4
>  .B \-\-entire\-thread
>  
> -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.
> +By default (except when format=json) 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.

I think stating this in terms of defaults that aren't really defaults
is what makes this cumbersome.  What about something like

.B \-\-entire\-thread=(true|false)

If true, 
.B notmuch show
returns all messages in the thread of any message matching the search
terms, rather than returning only the matching messages.  For
.B --format=json
this defaults to true.  For other formats, this defaults to false.

>  .RE
>  
>  .RS 4
> @@ -55,11 +55,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