]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config/notes.txt
Merge branch 'jk/escaped-wildcard-dwim'
[thirdparty/git.git] / Documentation / config / notes.txt
CommitLineData
e50472d8
NTND
1notes.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.
6
7notes.<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.
12
13notes.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.
21+
22This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
23environment variable, which must be a colon separated list of refs or
24globs.
25+
26The effective value of "core.notesRef" (possibly overridden by
27GIT_NOTES_REF) is also implicitly added to the list of refs to be
28displayed.
29
30notes.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.
36
37notes.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`.
43+
44This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
45environment variable.
46
47notes.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.
52+
53Does not have a default value; you must configure this variable to
54enable note rewriting. Set it to `refs/notes/commits` to enable
55rewriting for the default commit notes.
56+
57This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
58environment variable, which must be a colon separated list of refs or
59globs.