threads / patch / 31224

patchmergetool,difftool: Document --tool-help consistently

Subject: [PATCH] mergetool,difftool: Document --tool-help consistently

## tl;dr

3 messages between Aug 10, 2012 and Aug 10, 2012. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

David Aguilar· Aug 10, 2012, 04:52 UTC · lore
Add an entry for --tool-help to the mergetool documentation.

Move --tool-help in the difftool documentation so that it is listed immediately after --tool so that it is easier to find.

Signed-off-by: David Aguilar <davvid@gmail.com>
---
Based on work in next.

This is not urgent as the current difftool topics are cooking and will not be in the current release cycle.

 Documentation/git-difftool.txt  | 6 +++---
 Documentation/git-mergetool.txt | 3 +++
 2 files changed, 6 insertions(+), 3 deletions(-)
Show changes to 2 files +6 −2

Documentation/git-difftool.txt, Documentation/git-mergetool.txt

diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 313d54e..73ca702 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -66,6 +66,9 @@ of the diff post-image.  `$MERGED` is the name of the file which is
 being compared. `$BASE` is provided for compatibility
 with custom merge tool commands and has the same value as `$MERGED`.
 
+--tool-help::
+	Print a list of diff tools that may be used with `--tool`.
+
 --symlinks::
 --no-symlinks::
 	'git difftool''s default behavior is create symlinks to the
@@ -74,9 +77,6 @@ with custom merge tool commands and has the same value as `$MERGED`.
 	Specifying `--no-symlinks` instructs 'git difftool' to create
 	copies instead.  `--no-symlinks` is the default on Windows.
 
---tool-help::
-	Print a list of diff tools that may be used with `--tool`.
-
 -x <command>::
 --extcmd=<command>::
 	Specify a custom command for viewing diffs.
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index d7207bd..7100237 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -64,6 +64,9 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
 Otherwise, 'git mergetool' will prompt the user to indicate the
 success of the resolution after the custom tool has exited.
 
+--tool-help::
+	Print a list of diff tools that may be used with `--tool`.
+
 -y::
 --no-prompt::
 	Don't prompt before each invocation of the merge resolution

-- 
1.7.12.rc2.16.g034161a
Sebastian Schuberth· Aug 10, 2012, 07:17 UTC · re: David Aguilar · lore

Re: [PATCH] mergetool,difftool: Document --tool-help consistently

On Fri, Aug 10, 2012 at 6:52 AM, David Aguilar <davvid@gmail.com> wrote:
Show 6 quoted lines
> Add an entry for --tool-help to the mergetool documentation.
>
> Move --tool-help in the difftool documentation so that it is
> listed immediately after --tool so that it is easier to find.
>
> Signed-off-by: David Aguilar <davvid@gmail.com>

Funny, I was doing almost the same thing in [1], so I obviously like it. Back then Junio found it "Meh" because "it already is mentioned in the description of --tool above", but I still think all available command line option should be listed as such.

Show 9 quoted lines
> --- a/Documentation/git-mergetool.txt
> +++ b/Documentation/git-mergetool.txt
> @@ -64,6 +64,9 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
>  Otherwise, 'git mergetool' will prompt the user to indicate the
>  success of the resolution after the custom tool has exited.
>
> +--tool-help::
> +       Print a list of diff tools that may be used with `--tool`.
> +
This should say "list of merge tools", however.
[1] http://thread.gmane.org/gmane.comp.version-control.git/201913/focus=201922
-- 
Sebastian Schuberth
Junio C Hamano· Aug 10, 2012, 15:04 UTC · re: Sebastian Schuberth · lore

Re: [PATCH] mergetool,difftool: Document --tool-help consistently

Sebastian Schuberth <sschuberth@gmail.com> writes:
Show 13 quoted lines
> On Fri, Aug 10, 2012 at 6:52 AM, David Aguilar <davvid@gmail.com> wrote:
>
>> Add an entry for --tool-help to the mergetool documentation.
>>
>> Move --tool-help in the difftool documentation so that it is
>> listed immediately after --tool so that it is easier to find.
>>
>> Signed-off-by: David Aguilar <davvid@gmail.com>
>
> Funny, I was doing almost the same thing in [1], so I obviously
> like it. Back then Junio found it "Meh" because "it already is
> mentioned in the description of --tool above", but I still think
> all available command line option should be listed as such.

Either way is fine by me. Even though I do not think it adds much value, there is no reason to hiding the option; it is not like we are discouraging the use of it.

Let's take the version with the description of --tool-help, then, and have it next to the description of --tool.

Thanks for sanity checking.
Show 11 quoted lines
>> --- a/Documentation/git-mergetool.txt
>> +++ b/Documentation/git-mergetool.txt
>> @@ -64,6 +64,9 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
>>  Otherwise, 'git mergetool' will prompt the user to indicate the
>>  success of the resolution after the custom tool has exited.
>>
>> +--tool-help::
>> +       Print a list of diff tools that may be used with `--tool`.
>> +
>
> This should say "list of merge tools", however.
Will amend while queuing.
Thanks.

← back to recent threads