diff options
Diffstat (limited to 'git-notes.html')
| -rw-r--r-- | git-notes.html | 54 |
1 files changed, 36 insertions, 18 deletions
diff --git a/git-notes.html b/git-notes.html index 9e1177710..230ed94ac 100644 --- a/git-notes.html +++ b/git-notes.html @@ -784,7 +784,7 @@ message, after an unindented line saying "Notes (<refname>):" (or using the <code>--notes</code> option. Such notes are added as a patch commentary
after a three dash separator line.</p></div>
<div class="paragraph"><p>To change which notes are shown by <em>git log</em>, see the
-"notes.displayRef" configuration in <a href="git-log.html">git-log(1)</a>.</p></div>
+"notes.displayRef" discussion in <a href="#CONFIGURATION">[CONFIGURATION]</a>.</p></div>
<div class="paragraph"><p>See the "notes.rewrite.<command>" configuration for a way to carry
notes across commands that rewrite commits.</p></div>
</div>
@@ -1186,7 +1186,7 @@ some special-purpose tools to do something useful with them.</p></div> </div>
</div>
<div class="sect1">
-<h2 id="_configuration">CONFIGURATION</h2>
+<h2 id="CONFIGURATION">CONFIGURATION</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
@@ -1200,6 +1200,11 @@ core.notesRef command line.
</p>
</dd>
+</dl></div>
+<div class="paragraph"><p>Everything above this line in this section isn’t included from the
+<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
+same as what’s found there:</p></div>
+<div class="dlist"><dl>
<dt class="hdlist1">
notes.mergeStrategy
</dt>
@@ -1208,9 +1213,10 @@ notes.mergeStrategy Which merge strategy to choose by default when resolving notes
conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
<code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES"
- section above for more information on each strategy.
+ section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
</p>
-<div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option.</p></div>
+<div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
+<a href="git-notes.html">git-notes(1)</a>.</p></div>
</dd>
<dt class="hdlist1">
notes.<name>.mergeStrategy
@@ -1219,8 +1225,8 @@ notes.<name>.mergeStrategy <p>
Which merge strategy to choose when doing a notes merge into
refs/notes/<name>. This overrides the more general
- "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above
- for more information on each available strategy.
+ "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
+ <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
</p>
</dd>
<dt class="hdlist1">
@@ -1232,10 +1238,18 @@ notes.displayRef addition to the default set by <code>core.notesRef</code> or
<code>GIT_NOTES_REF</code>, to read notes from when showing commit
messages with the <em>git log</em> family of commands.
- This setting can be overridden on the command line or by the
- <code>GIT_NOTES_DISPLAY_REF</code> environment variable.
- See <a href="git-log.html">git-log(1)</a>.
</p>
+<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
+environment variable, which must be a colon separated list of refs or
+globs.</p></div>
+<div class="paragraph"><p>A warning will be issued for refs that do not exist,
+but a glob that does not match any refs is silently ignored.</p></div>
+<div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
+log</em> family of commands, or by the <code>--notes=<ref></code> option accepted by
+those commands.</p></div>
+<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
+GIT_NOTES_REF) is also implicitly added to the list of refs to be
+displayed.</p></div>
</dd>
<dt class="hdlist1">
notes.rewrite.<command>
@@ -1247,18 +1261,20 @@ notes.rewrite.<command> notes from the original to the rewritten commit. Defaults to
<code>true</code>. See also "<code>notes.rewriteRef</code>" below.
</p>
-<div class="paragraph"><p>This setting can be overridden by the <code>GIT_NOTES_REWRITE_REF</code>
-environment variable.</p></div>
+<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
+environment variable, which must be a colon separated list of refs or
+globs.</p></div>
</dd>
<dt class="hdlist1">
notes.rewriteMode
</dt>
<dd>
<p>
- When copying notes during a rewrite, what to do if the target
- commit already has a note. Must be one of <code>overwrite</code>,
- <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>. Defaults to
- <code>concatenate</code>.
+ When copying notes during a rewrite (see the
+ "notes.rewrite.<command>" option), determines what to do if
+ the target commit already has a note. Must be one of
+ <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
+ Defaults to <code>concatenate</code>.
</p>
<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
environment variable.</p></div>
@@ -1274,8 +1290,10 @@ notes.rewriteRef may also specify this configuration several times.
</p>
<div class="paragraph"><p>Does not have a default value; you must configure this variable to
-enable note rewriting.</p></div>
-<div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.</p></div>
+enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
+rewriting for the default commit notes.</p></div>
+<div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
+See <code>notes.rewrite.<command></code> above for a further description of its format.</p></div>
</dd>
</dl></div>
</div>
@@ -1344,7 +1362,7 @@ on the <code>notes.rewrite.<command></code> and <code>notes.rewriteRef</co <div id="footer">
<div id="footer-text">
Last updated
- 2020-08-10 16:45:05 PDT
+ 2022-09-14 13:23:11 PDT
</div>
</div>
</body>
|