Documentation/config/pack.txt: fix broken AsciiDoc mark-up
[alt-git.git] / Documentation / config / notes.txt
blob43db8e808d7ab763898ce5a860b8d4644bbc9f69
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 the "NOTES MERGE STRATEGIES"
5         section of linkgit:git-notes[1] for more information on each strategy.
7 This setting can be overridden by passing the `--strategy` option to
8 linkgit:git-notes[1].
10 notes.<name>.mergeStrategy::
11         Which merge strategy to choose when doing a notes merge into
12         refs/notes/<name>.  This overrides the more general
13         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
14         linkgit:git-notes[1] for more information on the available strategies.
16 notes.displayRef::
17         Which ref (or refs, if a glob or specified more than once), in
18         addition to the default set by `core.notesRef` or
19         `GIT_NOTES_REF`, to read notes from when showing commit
20         messages with the 'git log' family of commands.
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 A warning will be issued for refs that do not exist,
27 but a glob that does not match any refs is silently ignored.
29 This setting can be disabled by the `--no-notes` option to the 'git
30 log' family of commands, or by the `--notes=<ref>` option accepted by
31 those commands.
33 The effective value of "core.notesRef" (possibly overridden by
34 GIT_NOTES_REF) is also implicitly added to the list of refs to be
35 displayed.
37 notes.rewrite.<command>::
38         When rewriting commits with <command> (currently `amend` or
39         `rebase`), if this variable is `false`, git will not copy
40         notes from the original to the rewritten commit.  Defaults to
41         `true`.  See also "`notes.rewriteRef`" below.
43 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
44 environment variable, which must be a colon separated list of refs or
45 globs.
47 notes.rewriteMode::
48         When copying notes during a rewrite (see the
49         "notes.rewrite.<command>" option), determines what to do if
50         the target commit already has a note.  Must be one of
51         `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
52         Defaults to `concatenate`.
54 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
55 environment variable.
57 notes.rewriteRef::
58         When copying notes during a rewrite, specifies the (fully
59         qualified) ref whose notes should be copied.  May be a glob,
60         in which case notes in all matching refs will be copied.  You
61         may also specify this configuration several times.
63 Does not have a default value; you must configure this variable to
64 enable note rewriting.  Set it to `refs/notes/commits` to enable
65 rewriting for the default commit notes.
67 Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.
68 See `notes.rewrite.<command>` above for a further description of its format.