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