# [PATCH] mergetool,difftool: Document --tool-help consistently 3 messages from 2012-08-10 to 2012-08-10. Participants: David Aguilar, Sebastian Schuberth, Junio C Hamano. Thread: https://gitlist.dev/t/31224 ## David Aguilar, 2012-08-10 04:52 Subject: [PATCH] mergetool,difftool: Document --tool-help consistently Message-ID: <1344574365-5534-1-git-send-email-davvid@gmail.com> URL: https://gitlist.dev/e/1344574365-5534-1-git-send-email-davvid%40gmail.com ``` 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 --- 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(-) 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 :: --extcmd=:: 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..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, 2012-08-10 07:17 Subject: Re: [PATCH] mergetool,difftool: Document --tool-help consistently Message-ID: URL: https://gitlist.dev/e/CAHGBnuMCLkALCCAp1MiwQ1J%2BTuUhD%3D4k3LTGP2BMrp1LThb%3DHQ%40mail.gmail.com In-Reply-To: <1344574365-5534-1-git-send-email-davvid@gmail.com> ``` On Fri, Aug 10, 2012 at 6:52 AM, David Aguilar 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 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. > --- a/Documentation/git-mergetool.txt > +++ b/Documentation/git-mergetool.txt > @@ -64,6 +64,9 @@ variable `mergetool..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, 2012-08-10 15:04 Subject: Re: [PATCH] mergetool,difftool: Document --tool-help consistently Message-ID: <7vk3x6lreb.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vk3x6lreb.fsf%40alter.siamese.dyndns.org In-Reply-To: ``` Sebastian Schuberth writes: > On Fri, Aug 10, 2012 at 6:52 AM, David Aguilar 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 > > 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. >> --- a/Documentation/git-mergetool.txt >> +++ b/Documentation/git-mergetool.txt >> @@ -64,6 +64,9 @@ variable `mergetool..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. ```