Imported Upstream version 2.27.0
[platform/upstream/git.git] / Documentation / config / merge.txt
1 merge.conflictStyle::
2         Specify the style in which conflicted hunks are written out to
3         working tree files upon merge.  The default is "merge", which
4         shows a `<<<<<<<` conflict marker, changes made by one side,
5         a `=======` marker, changes made by the other side, and then
6         a `>>>>>>>` marker.  An alternate style, "diff3", adds a `|||||||`
7         marker and the original text before the `=======` marker.
8
9 merge.defaultToUpstream::
10         If merge is called without any commit argument, merge the upstream
11         branches configured for the current branch by using their last
12         observed values stored in their remote-tracking branches.
13         The values of the `branch.<current branch>.merge` that name the
14         branches at the remote named by `branch.<current branch>.remote`
15         are consulted, and then they are mapped via `remote.<remote>.fetch`
16         to their corresponding remote-tracking branches, and the tips of
17         these tracking branches are merged.
18
19 merge.ff::
20         By default, Git does not create an extra merge commit when merging
21         a commit that is a descendant of the current commit. Instead, the
22         tip of the current branch is fast-forwarded. When set to `false`,
23         this variable tells Git to create an extra merge commit in such
24         a case (equivalent to giving the `--no-ff` option from the command
25         line). When set to `only`, only such fast-forward merges are
26         allowed (equivalent to giving the `--ff-only` option from the
27         command line).
28
29 merge.verifySignatures::
30         If true, this is equivalent to the --verify-signatures command
31         line option. See linkgit:git-merge[1] for details.
32
33 include::fmt-merge-msg.txt[]
34
35 merge.renameLimit::
36         The number of files to consider when performing rename detection
37         during a merge; if not specified, defaults to the value of
38         diff.renameLimit. This setting has no effect if rename detection
39         is turned off.
40
41 merge.renames::
42         Whether Git detects renames.  If set to "false", rename detection
43         is disabled. If set to "true", basic rename detection is enabled.
44         Defaults to the value of diff.renames.
45
46 merge.directoryRenames::
47         Whether Git detects directory renames, affecting what happens at
48         merge time to new files added to a directory on one side of
49         history when that directory was renamed on the other side of
50         history.  If merge.directoryRenames is set to "false", directory
51         rename detection is disabled, meaning that such new files will be
52         left behind in the old directory.  If set to "true", directory
53         rename detection is enabled, meaning that such new files will be
54         moved into the new directory.  If set to "conflict", a conflict
55         will be reported for such paths.  If merge.renames is false,
56         merge.directoryRenames is ignored and treated as false.  Defaults
57         to "conflict".
58
59 merge.renormalize::
60         Tell Git that canonical representation of files in the
61         repository has changed over time (e.g. earlier commits record
62         text files with CRLF line endings, but recent ones use LF line
63         endings).  In such a repository, Git can convert the data
64         recorded in commits to a canonical form before performing a
65         merge to reduce unnecessary conflicts.  For more information,
66         see section "Merging branches with differing checkin/checkout
67         attributes" in linkgit:gitattributes[5].
68
69 merge.stat::
70         Whether to print the diffstat between ORIG_HEAD and the merge result
71         at the end of the merge.  True by default.
72
73 merge.autoStash::
74         When set to true, automatically create a temporary stash entry
75         before the operation begins, and apply it after the operation
76         ends.  This means that you can run merge on a dirty worktree.
77         However, use with care: the final stash application after a
78         successful merge might result in non-trivial conflicts.
79         This option can be overridden by the `--no-autostash` and
80         `--autostash` options of linkgit:git-merge[1].
81         Defaults to false.
82
83 merge.tool::
84         Controls which merge tool is used by linkgit:git-mergetool[1].
85         The list below shows the valid built-in values.
86         Any other value is treated as a custom merge tool and requires
87         that a corresponding mergetool.<tool>.cmd variable is defined.
88
89 merge.guitool::
90         Controls which merge tool is used by linkgit:git-mergetool[1] when the
91         -g/--gui flag is specified. The list below shows the valid built-in values.
92         Any other value is treated as a custom merge tool and requires that a
93         corresponding mergetool.<guitool>.cmd variable is defined.
94
95 include::../mergetools-merge.txt[]
96
97 merge.verbosity::
98         Controls the amount of output shown by the recursive merge
99         strategy.  Level 0 outputs nothing except a final error
100         message if conflicts were detected. Level 1 outputs only
101         conflicts, 2 outputs conflicts and file changes.  Level 5 and
102         above outputs debugging information.  The default is level 2.
103         Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable.
104
105 merge.<driver>.name::
106         Defines a human-readable name for a custom low-level
107         merge driver.  See linkgit:gitattributes[5] for details.
108
109 merge.<driver>.driver::
110         Defines the command that implements a custom low-level
111         merge driver.  See linkgit:gitattributes[5] for details.
112
113 merge.<driver>.recursive::
114         Names a low-level merge driver to be used when
115         performing an internal merge between common ancestors.
116         See linkgit:gitattributes[5] for details.