Merge branch 'jt/merge-recursive-symlink-is-not-a-dir-in-way'
[alt-git.git] / Documentation / config / notes.txt
blobaeef56d49ae97dc0df99b1e63f0a842f36f3142e
1 notes.mergeStrategy::
2         Which merge strategy to choose by default when resolving notes
3         conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
4         `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
5         section of linkgit:git-notes[1] for more information on each strategy.
7 notes.<name>.mergeStrategy::
8         Which merge strategy to choose when doing a notes merge into
9         refs/notes/<name>.  This overrides the more general
10         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
11         linkgit:git-notes[1] for more information on the available strategies.
13 notes.displayRef::
14         The (fully qualified) refname from which to show notes when
15         showing commit messages.  The value of this variable can be set
16         to a glob, in which case notes from all matching refs will be
17         shown.  You may also specify this configuration variable
18         several times.  A warning will be issued for refs that do not
19         exist, but a glob that does not match any refs is silently
20         ignored.
22 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
23 environment variable, which must be a colon separated list of refs or
24 globs.
26 The effective value of "core.notesRef" (possibly overridden by
27 GIT_NOTES_REF) is also implicitly added to the list of refs to be
28 displayed.
30 notes.rewrite.<command>::
31         When rewriting commits with <command> (currently `amend` or
32         `rebase`) and this variable is set to `true`, Git
33         automatically copies your notes from the original to the
34         rewritten commit.  Defaults to `true`, but see
35         "notes.rewriteRef" below.
37 notes.rewriteMode::
38         When copying notes during a rewrite (see the
39         "notes.rewrite.<command>" option), determines what to do if
40         the target commit already has a note.  Must be one of
41         `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
42         Defaults to `concatenate`.
44 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
45 environment variable.
47 notes.rewriteRef::
48         When copying notes during a rewrite, specifies the (fully
49         qualified) ref whose notes should be copied.  The ref may be a
50         glob, in which case notes in all matching refs will be copied.
51         You may also specify this configuration several times.
53 Does not have a default value; you must configure this variable to
54 enable note rewriting.  Set it to `refs/notes/commits` to enable
55 rewriting for the default commit notes.
57 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
58 environment variable, which must be a colon separated list of refs or
59 globs.