threads / patch / 29959

patchDocumentation/difftool: add deltawalker to list of valid diff tools

Subject: [PATCH] Documentation/difftool: add deltawalker to list of valid diff tools

## tl;dr

4 messages between Mar 15, 2012 and Mar 15, 2012. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

Tim Henigan· Mar 15, 2012, 16:28 UTC · lore

deltawalker has been supported since 284a126c3ef3, but was not added to the list of valid diff tools reported by 'git difftool --help'.

Signed-off-by: Tim Henigan <tim.henigan@gmail.com>
---

The list of valid tools seems prone to error. Right now, there is nothing that tells people to update this documentation when new config files are added to 'mergetools'. Should I add a README to 'mergetools' with instructions to update this file? Or would it be better to replace the list in the help string with a more general statement like "<tool> must match one of the files located in $(git --exec-path)/mergetools"?

 Documentation/git-difftool.txt |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

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

diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 19d473c..fe38f66 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -32,8 +32,9 @@ OPTIONS
 --tool=<tool>::
 	Use the diff tool specified by <tool>.
 	Valid diff tools are:
-	araxis, bc3, diffuse, emerge, ecmerge, gvimdiff, kdiff3,
-	kompare, meld, opendiff, p4merge, tkdiff, vimdiff and xxdiff.
+	araxis, bc3, deltawalker, diffuse, emerge, ecmerge, gvimdiff,
+	kdiff3,	kompare, meld, opendiff, p4merge, tkdiff, vimdiff and
+	xxdiff.
 +
 If a diff tool is not specified, 'git difftool'
 will use the configuration variable `diff.tool`.  If the

-- 
1.7.10.rc1

Junio C Hamano· Mar 15, 2012, 20:56 UTC · re: Tim Henigan · lore

Re: [PATCH] Documentation/difftool: add deltawalker to list of valid diff tools

Tim Henigan <tim.henigan@gmail.com> writes:

Show 6 quoted lines

> The list of valid tools seems prone to error. Right now, there is nothing
> that tells people to update this documentation when new config files are
> added to 'mergetools'.  Should I add a README to 'mergetools' with
> instructions to update this file?  Or would it be better to replace the
> list in the help string with a more general statement like "<tool> must
> match one of the files located in $(git --exec-path)/mergetools"?

I would prefer to rip most of them out from this list in the documentation, and refer people to ask the installed version of "git difftool" to list them. After bc7a96a (mergetool--lib: Refactor tools into separate files, 2011-08-18), that should be the most sensible option. I.e.

	--tool=<tool>::
		Use the diff tool specified by <tool>.  Valid diff tools
                include emerge, kompare, meld, and vimdiff; for complete
                list, run 'git difftool --tool-help'

or something.

Junio C Hamano· Mar 15, 2012, 22:16 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation/difftool: add deltawalker to list of valid diff tools

Junio C Hamano <gitster@pobox.com> writes:

Show 21 quoted lines

> Tim Henigan <tim.henigan@gmail.com> writes:
>
>> The list of valid tools seems prone to error. Right now, there is nothing
>> that tells people to update this documentation when new config files are
>> added to 'mergetools'.  Should I add a README to 'mergetools' with
>> instructions to update this file?  Or would it be better to replace the
>> list in the help string with a more general statement like "<tool> must
>> match one of the files located in $(git --exec-path)/mergetools"?
>
> I would prefer to rip most of them out from this list in the
> documentation, and refer people to ask the installed version of "git
> difftool" to list them.  After bc7a96a (mergetool--lib: Refactor tools
> into separate files, 2011-08-18), that should be the most sensible option.
> I.e.
>
> 	--tool=<tool>::
> 		Use the diff tool specified by <tool>.  Valid diff tools
>                 include emerge, kompare, meld, and vimdiff; for complete
>                 list, run 'git difftool --tool-help'
>
> or something.

The above is the longer-term direction. I'll apply your patch to add another new tool to the existing list for 1.7.10.

Tim Henigan· Mar 15, 2012, 22:21 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation/difftool: add deltawalker to list of valid diff tools

On Thu, Mar 15, 2012 at 6:16 PM, Junio C Hamano <gitster@pobox.com> wrote:

>
> The above is the longer-term direction. I'll apply your patch to add
> another new tool to the existing list for 1.7.10.

I am almost done with a patch to do this...I was planning to send it in the next few minutes.

Thanks, Tim