[BUG] was: Re: [PATCH] Remove --no-gui option from difftool usage string

From: David Aguilar <davvid@gmail.com>
Date: Feb 5, 2017, 20:17 UTC
Message-ID: <20170205201751.z4rfmy5xxaqg472l@gmail.com>
In-Reply-To: <20170204025617.GA9221@arch-attack.localdomain>

On Fri, Feb 03, 2017 at 06:56:17PM -0800, Denton Liu wrote:

Show 8 quoted lines

> The --no-gui option not documented in the manpage, nor is it actually
> used in the source code. This change removes it from the usage help
> that's printed.
> 
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
>  git-difftool.perl | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

[Dscho, I found a bug, see below]

I forgot to mention that the scripted difftool has been rewritten in C and will be going away soon. builtin/difftool.c is already in "next".

New patches against difftool should target the builtin.

Regarding removing it from the usage string, IMO that can be considered a good change if the rationale were instead that we never expect users to ever type "--no-gui" in practice.

Wasting the short usage string screen space with a useless to 99.99% users option is bad for usability. From that perspective we shouldn't mention it there, so reframing the commit message towards that argument would make for a better motivation.

Removing the mention from the usage string and adding it to the manpage would be the a good change from that perspective as well.

BTW, in "next", it seems that the builtin difftool crashes when doing "git difftool -h", so we should probably add a test for that too...

From the tip of next:

$ git difftool -h fatal: BUG: setup_git_env called without repository

-- 
David