]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/config/mergetool.txt
Merge branch 'jk/sequencer-missing-author-name-check' into maint-2.38
[thirdparty/git.git] / Documentation / config / mergetool.txt
1 mergetool.<tool>.path::
2 Override the path for the given tool. This is useful in case
3 your tool is not in the PATH.
4
5 mergetool.<tool>.cmd::
6 Specify the command to invoke the specified merge tool. The
7 specified command is evaluated in shell with the following
8 variables available: 'BASE' is the name of a temporary file
9 containing the common base of the files to be merged, if available;
10 'LOCAL' is the name of a temporary file containing the contents of
11 the file on the current branch; 'REMOTE' is the name of a temporary
12 file containing the contents of the file from the branch being
13 merged; 'MERGED' contains the name of the file to which the merge
14 tool should write the results of a successful merge.
15
16 mergetool.<tool>.hideResolved::
17 Allows the user to override the global `mergetool.hideResolved` value
18 for a specific tool. See `mergetool.hideResolved` for the full
19 description.
20
21 mergetool.<tool>.trustExitCode::
22 For a custom merge command, specify whether the exit code of
23 the merge command can be used to determine whether the merge was
24 successful. If this is not set to true then the merge target file
25 timestamp is checked and the merge assumed to have been successful
26 if the file has been updated, otherwise the user is prompted to
27 indicate the success of the merge.
28
29 mergetool.meld.hasOutput::
30 Older versions of `meld` do not support the `--output` option.
31 Git will attempt to detect whether `meld` supports `--output`
32 by inspecting the output of `meld --help`. Configuring
33 `mergetool.meld.hasOutput` will make Git skip these checks and
34 use the configured value instead. Setting `mergetool.meld.hasOutput`
35 to `true` tells Git to unconditionally use the `--output` option,
36 and `false` avoids using `--output`.
37
38 mergetool.meld.useAutoMerge::
39 When the `--auto-merge` is given, meld will merge all non-conflicting
40 parts automatically, highlight the conflicting parts and wait for
41 user decision. Setting `mergetool.meld.useAutoMerge` to `true` tells
42 Git to unconditionally use the `--auto-merge` option with `meld`.
43 Setting this value to `auto` makes git detect whether `--auto-merge`
44 is supported and will only use `--auto-merge` when available. A
45 value of `false` avoids using `--auto-merge` altogether, and is the
46 default value.
47
48 mergetool.vimdiff.layout::
49 The vimdiff backend uses this variable to control how its split
50 windows look like. Applies even if you are using Neovim (`nvim`) or
51 gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
52 ifndef::git-mergetool[]
53 in linkgit:git-mergetool[1].
54 endif::[]
55 for details.
56
57 mergetool.hideResolved::
58 During a merge Git will automatically resolve as many conflicts as
59 possible and write the 'MERGED' file containing conflict markers around
60 any conflicts that it cannot resolve; 'LOCAL' and 'REMOTE' normally
61 represent the versions of the file from before Git's conflict
62 resolution. This flag causes 'LOCAL' and 'REMOTE' to be overwriten so
63 that only the unresolved conflicts are presented to the merge tool. Can
64 be configured per-tool via the `mergetool.<tool>.hideResolved`
65 configuration variable. Defaults to `false`.
66
67 mergetool.keepBackup::
68 After performing a merge, the original file with conflict markers
69 can be saved as a file with a `.orig` extension. If this variable
70 is set to `false` then this file is not preserved. Defaults to
71 `true` (i.e. keep the backup files).
72
73 mergetool.keepTemporaries::
74 When invoking a custom merge tool, Git uses a set of temporary
75 files to pass to the tool. If the tool returns an error and this
76 variable is set to `true`, then these temporary files will be
77 preserved, otherwise they will be removed after the tool has
78 exited. Defaults to `false`.
79
80 mergetool.writeToTemp::
81 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
82 conflicting files in the worktree by default. Git will attempt
83 to use a temporary directory for these files when set `true`.
84 Defaults to `false`.
85
86 mergetool.prompt::
87 Prompt before each invocation of the merge resolution program.