Re: [PATCH] documentation fix: git difftool uses diff tools, not merge tools.

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 15, 2011, 00:20 UTC
Message-ID: <7v62imi6c7.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1321311352-8950-1-git-send-email-thh@inter.net>

Thomas Hochstein <thh@inter.net> writes:

Show 21 quoted lines

> Let the documentation for -t list valid *diff* tools,
> not valid *merge* tools.
>
> Signed-off-by: Thomas Hochstein <thh@inter.net>
> ---
>  Documentation/git-difftool.txt |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
> index a03515f..19d473c 100644
> --- a/Documentation/git-difftool.txt
> +++ b/Documentation/git-difftool.txt
> @@ -31,7 +31,7 @@ OPTIONS
>  -t <tool>::
>  --tool=<tool>::
>  	Use the diff tool specified by <tool>.
> -	Valid merge tools are:
> +	Valid diff tools are:
>  	araxis, bc3, diffuse, emerge, ecmerge, gvimdiff, kdiff3,
>  	kompare, meld, opendiff, p4merge, tkdiff, vimdiff and xxdiff.
>  +

The patch is obviously correct, and it is so trivial that there is no risk of breaking anything. It would even be OK for 1.7.7.X maintenance series.

But in the longer term, I suspect that we would want to drop this enumeration from the documentation, and instead give "--list-tools" option or something to the command. That way, we only need to keep the list of known tools in one place where it matters, namely, the command that knows about them.

David, what do you think?

The same comment applies to "git mergetool", I would think.