mirror of
https://github.com/git/git.git
synced 2024-12-05 07:53:59 +08:00
42943b950e
When no merge.tool or diff.tool is configured or manually selected, the selection of a default tool is sensitive to the DISPLAY variable; in a GUI session a gui-specific tool will be proposed if found, and otherwise a terminal-based one. This "GUI-optimizing" behavior is important because a GUI can make a huge difference to a user's ability to understand and correctly complete a non-trivial conflicting merge. Some time ago the merge.guitool and diff.guitool config options were introduced to enable users to configure both a GUI tool, and a non-GUI tool (with fallback if no GUI tool configured), in the same environment. Unfortunately, the --gui argument introduced to support the selection of the guitool is still explicit. When using configured tools, there is no equivalent of the no-tool-configured "propose a GUI tool if we are in a GUI environment" behavior. As proposed in <xmqqmtb8jsej.fsf@gitster.g>, introduce new configuration options, difftool.guiDefault and mergetool.guiDefault, supporting a special value "auto" which causes the corresponding tool or guitool to be selected depending on the presence of a non-empty DISPLAY value. Also support "true" to say "default to the guitool (unless --no-gui is passed on the commandline)", and "false" as the previous default behavior when these new configuration options are not specified. Signed-off-by: Tao Klerks <tao@klerks.biz> Acked-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
131 lines
4.4 KiB
Plaintext
131 lines
4.4 KiB
Plaintext
git-mergetool(1)
|
|
================
|
|
|
|
NAME
|
|
----
|
|
git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Use `git mergetool` to run one of several merge utilities to resolve
|
|
merge conflicts. It is typically run after 'git merge'.
|
|
|
|
If one or more <file> parameters are given, the merge tool program will
|
|
be run to resolve differences on each file (skipping those without
|
|
conflicts). Specifying a directory will include all unresolved files in
|
|
that path. If no <file> names are specified, 'git mergetool' will run
|
|
the merge tool program on every file with merge conflicts.
|
|
|
|
OPTIONS
|
|
-------
|
|
-t <tool>::
|
|
--tool=<tool>::
|
|
Use the merge resolution program specified by <tool>.
|
|
Valid values include emerge, gvimdiff, kdiff3,
|
|
meld, vimdiff, and tortoisemerge. Run `git mergetool --tool-help`
|
|
for the list of valid <tool> settings.
|
|
+
|
|
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
|
|
can configure the absolute path to kdiff3 by setting
|
|
`mergetool.kdiff3.path`. Otherwise, 'git mergetool' assumes the
|
|
tool is available in PATH.
|
|
+
|
|
Instead of running one of the known merge tool programs,
|
|
'git mergetool' can be customized to run an alternative program
|
|
by specifying the command line to invoke in a configuration
|
|
variable `mergetool.<tool>.cmd`.
|
|
+
|
|
When 'git mergetool' is invoked with this tool (either through the
|
|
`-t` or `--tool` option or the `merge.tool` configuration
|
|
variable) the configured command line will be invoked with `$BASE`
|
|
set to the name of a temporary file containing the common base for
|
|
the merge, if available; `$LOCAL` set to the name of a temporary
|
|
file containing the contents of the file on the current branch;
|
|
`$REMOTE` set to the name of a temporary file containing the
|
|
contents of the file to be merged, and `$MERGED` set to the name
|
|
of the file to which the merge tool should write the result of the
|
|
merge resolution.
|
|
+
|
|
If the custom merge tool correctly indicates the success of a
|
|
merge resolution with its exit code, then the configuration
|
|
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
|
|
program.
|
|
This is the default if the merge resolution program is
|
|
explicitly specified with the `--tool` option or with the
|
|
`merge.tool` configuration variable.
|
|
|
|
--prompt::
|
|
Prompt before each invocation of the merge resolution program
|
|
to give the user a chance to skip the path.
|
|
|
|
-g::
|
|
--gui::
|
|
When 'git-mergetool' is invoked with the `-g` or `--gui` option
|
|
the default merge tool will be read from the configured
|
|
`merge.guitool` variable instead of `merge.tool`. If
|
|
`merge.guitool` is not set, we will fallback to the tool
|
|
configured under `merge.tool`. This may be autoselected using
|
|
the configuration variable `mergetool.guiDefault`.
|
|
|
|
--no-gui::
|
|
This overrides a previous `-g` or `--gui` setting or
|
|
`mergetool.guiDefault` configuration and reads the default merge
|
|
tool from the configured `merge.tool` variable.
|
|
|
|
-O<orderfile>::
|
|
Process files in the order specified in the
|
|
<orderfile>, which has one shell glob pattern per line.
|
|
This overrides the `diff.orderFile` configuration variable
|
|
(see linkgit:git-config[1]). To cancel `diff.orderFile`,
|
|
use `-O/dev/null`.
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
:git-mergetool: 1
|
|
|
|
include::includes/cmd-config-section-all.txt[]
|
|
|
|
include::config/mergetool.txt[]
|
|
|
|
TEMPORARY FILES
|
|
---------------
|
|
`git mergetool` creates `*.orig` backup files while resolving merges.
|
|
These are safe to remove once a file has been merged and its
|
|
`git mergetool` session has completed.
|
|
|
|
Setting the `mergetool.keepBackup` configuration variable to `false`
|
|
causes `git mergetool` to automatically remove the backup as files
|
|
are successfully merged.
|
|
|
|
BACKEND SPECIFIC HINTS
|
|
----------------------
|
|
|
|
vimdiff
|
|
~~~~~~~
|
|
include::mergetools/vimdiff.txt[]
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|