Merge branch 'dp/clean-fix'

[git.git] / Documentation / config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 8a0dff9f4949662f0a7f03e55fadf6f40597cde4..c5e094a9c4a31568e4efb2c70af7e7808ae63528 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -754,8 +754,10 @@ merge.summary::
 
 merge.tool::
        Controls which merge resolution program is used by
 
 merge.tool::
        Controls which merge resolution program is used by

-       linkgit:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
-       "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
+       linkgit:git-mergetool[1].  Valid built-in values are: "kdiff3",
+       "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and
+       "opendiff".  Any other value is treated is custom merge tool
+       and there must be a corresponing mergetool.<tool>.cmd option.

 
 merge.verbosity::
        Controls the amount of output shown by the recursive merge
 
 merge.verbosity::
        Controls the amount of output shown by the recursive merge


@@ -782,6 +784,31 @@ mergetool.<tool>.path::
        Override the path for the given tool.  This is useful in case
        your tool is not in the PATH.
 
        Override the path for the given tool.  This is useful in case
        your tool is not in the PATH.
 

+mergetool.<tool>.cmd::
+       Specify the command to invoke the specified merge tool.  The
+       specified command is evaluated in shell with the following
+       variables available: 'BASE' is the name of a temporary file
+       containing the common base of the files to be merged, if available;
+       'LOCAL' is the name of a temporary file containing the contents of
+       the file on the current branch; 'REMOTE' is the name of a temporary
+       file containing the contents of the file from the branch being
+       merged; 'MERGED' contains the name of the file to which the merge
+       tool should write the results of a successful merge.
+
+mergetool.<tool>.trustExitCode::
+       For a custom merge command, specify whether the exit code of
+       the merge command can be used to determine whether the merge was
+       successful.  If this is not set to true then the merge target file
+       timestamp is checked and the merge assumed to have been successful
+       if the file has been updated, otherwise the user is prompted to
+       indicate the success of the merge.
+
+mergetool.keepBackup::
+       After performing a merge, the original file with conflict markers
+       can be saved as a file with a `.orig` extension.  If this variable
+       is set to `false` then this file is not preserved.  Defaults to
+       `true` (i.e. keep the backup files).
+

 pack.window::
        The size of the window used by linkgit:git-pack-objects[1] when no
        window size is given on the command line. Defaults to 10.
 pack.window::
        The size of the window used by linkgit:git-pack-objects[1] when no
        window size is given on the command line. Defaults to 10.


@@ -869,15 +896,15 @@ remote.<name>.skipDefaultUpdate::
 
 remote.<name>.receivepack::
        The default program to execute on the remote side when pushing.  See
 
 remote.<name>.receivepack::
        The default program to execute on the remote side when pushing.  See

-       option \--exec of linkgit:git-push[1].
+       option \--receive-pack of linkgit:git-push[1].

 
 remote.<name>.uploadpack::
        The default program to execute on the remote side when fetching.  See
 
 remote.<name>.uploadpack::
        The default program to execute on the remote side when fetching.  See

-       option \--exec of linkgit:git-fetch-pack[1].
+       option \--upload-pack of linkgit:git-fetch-pack[1].

 
 remote.<name>.tagopt::
 
 remote.<name>.tagopt::

-       Setting this value to --no-tags disables automatic tag following when fetching
-       from remote <name>
+       Setting this value to \--no-tags disables automatic tag following when
+       fetching from remote <name>

 
 remotes.<group>::
        The list of remotes which are fetched by "git remote update
 
 remotes.<group>::
        The list of remotes which are fetched by "git remote update