Autogenerated HTML docs for v2.48.1-166-g58b58

Author: gitster

Diff for: RelNotes/2.49.0.txt

@@ -109,10 +109,17 @@ Fixes since v2.48
    corrected.
    (merge a0bea0978f ps/reflog-migration-with-logall-fix later to maint).
 
+ * Doc and short-help text for "show-index" has been clarified to
+   stress that the command reads its data from the standard input.
+   (merge 49edce4ff9 jc/show-index-h-update later to maint).
+
  * Other code cleanup, docfix, build fix, etc.
    (merge ddb5287894 jk/t7407-use-test-grep later to maint).
    (merge 21e1b44865 aj/difftool-config-doc-fix later to maint).
    (merge 6a63995335 mh/gitattr-doc-markup-fix later to maint).
    (merge 43850dcf9c sk/unit-test-hash later to maint).
    (merge 4ad47d2de3 jc/cli-doc-option-and-config later to maint).
    (merge 2d0ff147e5 jp/t8002-printf-fix later to maint).
+   (merge 69666e6746 ja/doc-restore-markup-update later to maint).
+   (merge d11d003ba5 sk/strlen-returns-size_t later to maint).
+   (merge 77b2d29e91 ja/doc-notes-markup-updates later to maint).

Diff for: git-config.html

@@ -7008,7 +7008,7 @@ <h3 id="_variables">Variables</h3>
 variable value. The default is <code>false</code>, where the <code>--gui</code> argument
 must be provided explicitly for the <code>merge.guitool</code> to be used.</p>
 </dd>
-<dt class="hdlist1">notes.mergeStrategy</dt>
+<dt class="hdlist1"><code>notes.mergeStrategy</code></dt>
 <dd>
 <p>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
@@ -7019,19 +7019,19 @@ <h3 id="_variables">Variables</h3>
 <a href="git-notes.html">git-notes(1)</a>.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.&lt;name&gt;.mergeStrategy</dt>
+<dt class="hdlist1"><code>notes.</code><em>&lt;name&gt;</em><code>.mergeStrategy</code></dt>
 <dd>
 <p>Which merge strategy to choose when doing a notes merge into
-refs/notes/&lt;name&gt;.  This overrides the more general
-"notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
+<code>refs/notes/</code><em>&lt;name&gt;</em>.  This overrides the more general
+<code>notes.mergeStrategy</code>.  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">notes.displayRef</dt>
+<dt class="hdlist1"><code>notes.displayRef</code></dt>
 <dd>
 <p>Which ref (or refs, if a glob or specified more than once), in
 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.</p>
+messages with the <code>git</code> <code>log</code> family of commands.</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
@@ -7042,32 +7042,32 @@ <h3 id="_variables">Variables</h3>
 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=</code><em>&lt;ref&gt;</em> option accepted by
+<p>This setting can be disabled by the <code>--no-notes</code> option to the <a href="git-log.html">git-log(1)</a>
+family of commands, or by the <code>--notes=</code><em>&lt;ref&gt;</em> 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
+<p>The effective value of <code>core.notesRef</code> (possibly overridden by
+<code>GIT_NOTES_REF</code>) is also implicitly added to the list of refs to be
 displayed.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.rewrite.&lt;command&gt;</dt>
+<dt class="hdlist1"><code>notes.rewrite.</code><em>&lt;command&gt;</em></dt>
 <dd>
-<p>When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
+<p>When rewriting commits with <em>&lt;command&gt;</em> (currently <code>amend</code> or
 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
 notes from the original to the rewritten commit.  Defaults to
-<code>true</code>.  See also "<code>notes.rewriteRef</code>" below.</p>
+<code>true</code>.  See also <code>notes.rewriteRef</code> below.</p>
 <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>
+<dt class="hdlist1"><code>notes.rewriteMode</code></dt>
 <dd>
 <p>When copying notes during a rewrite (see the
-"notes.rewrite.&lt;command&gt;" option), determines what to do if
+<code>notes.rewrite.</code><em>&lt;command&gt;</em> 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>
@@ -7076,7 +7076,7 @@ <h3 id="_variables">Variables</h3>
 environment variable.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.rewriteRef</dt>
+<dt class="hdlist1"><code>notes.rewriteRef</code></dt>
 <dd>
 <p>When copying notes during a rewrite, specifies the (fully
 qualified) ref whose notes should be copied.  May be a glob,

Diff for: git-log.html

@@ -4305,7 +4305,7 @@ <h2 id="_configuration">CONFIGURATION</h2>
 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
 assume <code>--no-use-mailmap</code>. True by default.</p>
 </dd>
-<dt class="hdlist1">notes.mergeStrategy</dt>
+<dt class="hdlist1"><code>notes.mergeStrategy</code></dt>
 <dd>
 <p>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
@@ -4316,19 +4316,19 @@ <h2 id="_configuration">CONFIGURATION</h2>
 <a href="git-notes.html">git-notes(1)</a>.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.&lt;name&gt;.mergeStrategy</dt>
+<dt class="hdlist1"><code>notes.</code><em>&lt;name&gt;</em><code>.mergeStrategy</code></dt>
 <dd>
 <p>Which merge strategy to choose when doing a notes merge into
-refs/notes/&lt;name&gt;.  This overrides the more general
-"notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
+<code>refs/notes/</code><em>&lt;name&gt;</em>.  This overrides the more general
+<code>notes.mergeStrategy</code>.  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">notes.displayRef</dt>
+<dt class="hdlist1"><code>notes.displayRef</code></dt>
 <dd>
 <p>Which ref (or refs, if a glob or specified more than once), in
 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.</p>
+messages with the <code>git</code> <code>log</code> family of commands.</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
@@ -4339,32 +4339,32 @@ <h2 id="_configuration">CONFIGURATION</h2>
 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=</code><em>&lt;ref&gt;</em> option accepted by
+<p>This setting can be disabled by the <code>--no-notes</code> option to the <a href="git-log.html">git-log(1)</a>
+family of commands, or by the <code>--notes=</code><em>&lt;ref&gt;</em> 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
+<p>The effective value of <code>core.notesRef</code> (possibly overridden by
+<code>GIT_NOTES_REF</code>) is also implicitly added to the list of refs to be
 displayed.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.rewrite.&lt;command&gt;</dt>
+<dt class="hdlist1"><code>notes.rewrite.</code><em>&lt;command&gt;</em></dt>
 <dd>
-<p>When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
+<p>When rewriting commits with <em>&lt;command&gt;</em> (currently <code>amend</code> or
 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
 notes from the original to the rewritten commit.  Defaults to
-<code>true</code>.  See also "<code>notes.rewriteRef</code>" below.</p>
+<code>true</code>.  See also <code>notes.rewriteRef</code> below.</p>
 <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>
+<dt class="hdlist1"><code>notes.rewriteMode</code></dt>
 <dd>
 <p>When copying notes during a rewrite (see the
-"notes.rewrite.&lt;command&gt;" option), determines what to do if
+<code>notes.rewrite.</code><em>&lt;command&gt;</em> 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>
@@ -4373,7 +4373,7 @@ <h2 id="_configuration">CONFIGURATION</h2>
 environment variable.</p>
 </div>
 </dd>
-<dt class="hdlist1">notes.rewriteRef</dt>
+<dt class="hdlist1"><code>notes.rewriteRef</code></dt>
 <dd>
 <p>When copying notes during a rewrite, specifies the (fully
 qualified) ref whose notes should be copied.  May be a glob,