Re: [PATCH] Document the --no-gui option in difftool

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 6, 2017, 18:53 UTC
Message-ID: <xmqqa89z2ls1.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20170206034118.GA29517@arch-attack.localdomain>

Denton Liu <liu.denton@gmail.com> writes:

Show 17 quoted lines

> diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
> index 224fb3090..a2661d9cc 100644
> --- a/Documentation/git-difftool.txt
> +++ b/Documentation/git-difftool.txt
> @@ -87,9 +87,11 @@ instead.  `--no-symlinks` is the default on Windows.
>  
>  -g::
>  --gui::
> +--no-gui::
>  	When 'git-difftool' is invoked with the `-g` or `--gui` option
>  	the default diff tool will be read from the configured
> -	`diff.guitool` variable instead of `diff.tool`.
> +	`diff.guitool` variable instead of `diff.tool`. The `--no-gui`
> +	option can be used to override this setting.
>  
>  --[no-]trust-exit-code::
>  	'git-difftool' invokes a diff tool individually on each file.

Reading the whole of this file before applying this patch, I notice that we have descriptions of negative forms only for some but not all options. "--[no-]symlinks" and "--[no-]trust-exit-code" are already there, but not this one.

Shouldn't the patch be more like

    ---gui::
    +--[no-]gui::

to be consistent with its existing friends, though?