From: Michal Sojka <sojkam1@fel.cvut.cz>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH v2 06/10] cli: Introduce "notmuch address" command
In-Reply-To: <87d293mp9c.fsf@maritornes.cs.unb.ca>
References: <1415058622-21162-1-git-send-email-sojkam1@fel.cvut.cz>
	<1415058622-21162-7-git-send-email-sojkam1@fel.cvut.cz>
	<87d293mp9c.fsf@maritornes.cs.unb.ca>
User-Agent: Notmuch/0.18.2+157~ga00d359 (http://notmuchmail.org) Emacs/24.3.1
	(x86_64-pc-linux-gnu)
Date: Tue, 04 Nov 2014 22:59:47 +0100
Message-ID: <871tpimxt8.fsf@steelpick.2x.cz>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list

On Tue, Nov 04 2014, David Bremner wrote:
> Michal Sojka <sojkam1@fel.cvut.cz> writes:
>
>> +{
>> +    local cur prev words cword split
>> +    _init_completion -s || return
>> +
>> +    $split &&
>> +    case "${prev}" in
>> +	--format)
>> +	    COMPREPLY=( $( compgen -W "json sexp text text0" -- "${cur}" ) )
>> +	    return
>> +	    ;;
>> +	--output)
>> +	    COMPREPLY=( $( compgen -W "sender recipients" -- "${cur}" ) )
>> +	    return
>> +	    ;;
>> +	--sort)
>> +	    COMPREPLY=( $( compgen -W "newest-first oldest-first" -- "${cur}" ) )
>> +	    return
>> +	    ;;
>> +	--exclude)
>> +	    COMPREPLY=( $( compgen -W "true false flag all" -- "${cur}" ) )
>> +	    return
>> +	    ;;
>> +    esac
>> +
>> +    ! $split &&
>> +    case "${cur}" in
>> +	-*)
>> +	    local options="--format= --output= --sort= --exclude="
>> +	    compopt -o nospace
>> +	    COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
>> +	    ;;
>> +	*)
>> +	    _notmuch_search_terms
>> +	    ;;
>> +    esac
>> +}
>> +
>
> I am reminded that we have no tests for shell completion stuff, which
> seems pretty fragile.
>
>> +
>> +    ``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**)
>> +        Presents the results in either JSON, S-Expressions, newline
>> +        character separated plain-text (default), or null character
>> +        separated plain-text (compatible with **xargs(1)** -0 option
>> +        where available).
>> +
>> +    ``--format-version=N``
>> +        Use the specified structured output format version. This is
>> +        intended for programs that invoke **notmuch(1)** internally. If
>> +        omitted, the latest supported version will be used.
>> +
>
>
> I wonder if at some point we should have a notmuch-output-formats.7 page.
>
>
>> +    ``--exclude=(true|false|all|flag)``
>> +        A message is called "excluded" if it matches at least one tag in
>> +        search.tag\_exclude that does not appear explicitly in the
>> +        search terms. This option specifies whether to omit excluded
>> +        messages in the search process.
>
> Similarly for excludes.  I'm ok with the duplication for now, and I can
> see an argument for not making the user chase references.

What about using RST include directive [1] to include shared parts into
more documents?

[1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment

-Michal