threads / patch / 28936

patchdocumentation fix: git difftool uses diff tools, not merge tools.

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

## tl;dr

3 messages between Nov 14, 2011 and Nov 21, 2011. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Thomas Hochstein· Nov 14, 2011, 22:55 UTC · lore

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(-)

Show changes to Documentation/git-difftool.txt +1 −1

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.
 +

-- 
1.7.2.5

Junio C Hamano· Nov 15, 2011, 00:20 UTC · re: Thomas Hochstein · lore

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

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.

David Aguilar· Nov 21, 2011, 12:25 UTC · re: Junio C Hamano · lore

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

On Mon, Nov 14, 2011 at 4:20 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 36 quoted lines

> Thomas Hochstein <thh@inter.net> writes:
>
>> 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.

Exactly my thoughts.

-- 
    David