threads / patch / 31225

v2mergetool,difftool: Document --tool-help consistently

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

## tl;dr

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

replies: 1people: 1as markdown or json

David Aguilar· Aug 10, 2012, 07:39 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>
---
If you want to have --tool-help mentioned, use this patch.
 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..6b563c5 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 merge 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
David Aguilar· Aug 10, 2012, 07:39 UTC · re: David Aguilar · lore

[PATCH] mergetool,difftool: Simplify --tool-help documentation

Remove the entry for --tool-help in the documentation as it is already mentioned in the documentation for --tool.

Signed-off-by: David Aguilar <davvid@gmail.com>
---
Incompatible with the previous patch, but if you prefer to
mention --tool-help in the docs for --tool only, then choose
this one.
 Documentation/git-difftool.txt | 3 ---
 1 file changed, 3 deletions(-)
Show changes to Documentation/git-difftool.txt +0 −2
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 313d54e..ee80b00 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -74,9 +74,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.
-- 
1.7.12.rc2.16.g034161a

← back to recent threads