[PATCH 1/2] Follow the more popular highlighting convention in git-mergetool doc
- From
Charles Bailey <charles@hashpling.org>
- Date
- Mar 8, 2008, 20:46 UTC
- Message-ID
- <b4c3c2a6ee8fbc73d9c4f4582cc9c4ae6e58b15e.1205008859.git.charles@hashpling.org>
Signed-off-by: Charles Bailey <charles@hashpling.org> ---
I've just noticed that the only documentation for the new mergetool functionality is hidden in 'git help config' which is a little obscure. These two patches rectify this by adding documentation to 'git help mergetool'.
I've also switched some quotes to backticks to follow what seems to be the more popular quoting convention in the git documentation, but as I'm not an expert in how the docs work in all format perhaps someone can correct me and I can update the patch.
Documentation/git-mergetool.txt | 16 ++++++++-------- 1 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 50f106e..ac8969c 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -12,12 +12,12 @@ SYNOPSIS DESCRIPTION ----------- -Use 'git mergetool' to run one of several merge utilities to resolve +Use `git mergetool` to run one of several merge utilities to resolve merge conflicts. It is typically run after linkgit:git-merge[1]. If one or more <file> parameters are given, the merge tool program will be run to resolve differences on each file. If no <file> names are -specified, 'git mergetool' will run the merge tool program on every file +specified, `git mergetool` will run the merge tool program on every file with merge conflicts. OPTIONS @@ -27,16 +27,16 @@ OPTIONS Valid merge tools are: kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff + -If a merge resolution program is not specified, 'git mergetool' -will use the configuration variable merge.tool. If the -configuration variable merge.tool is not set, 'git mergetool' +If a merge resolution program is not specified, `git mergetool` +will use the configuration variable `merge.tool`. If the +configuration variable `merge.tool` is not set, `git mergetool` will pick a suitable default. + You can explicitly provide a full path to the tool by setting the -configuration variable mergetool.<tool>.path. For example, you +configuration variable `mergetool.<tool>.path`. For example, you can configure the absolute path to kdiff3 by setting -mergetool.kdiff3.path. Otherwise, 'git mergetool' assumes the tool -is available in PATH. +`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the +tool is available in PATH. Author ------
-- 1.5.4.3.432.g5ecfc