Autogenerated HTML docs for v2.48.1-329-ge2067

Author: gitster

RelNotes/2.49.0.txt

@@ -6,6 +6,19 @@ UI, Workflows & Features
 
  * Completion script updates for zsh
 
+ * "git pack-objects" and its wrapper "git repack" learned an option
+   to use an alternative path-hash function to improve delta-base
+   selection to produce a packfile with deeper history than window
+   size.
+
+ * "git gc" learned the "--expire-to" option and passes it down to
+   underlying "git repack".
+
+ * "[help] autocorrect = 1" used to be a way to say "please wait for
+   0.1 second after suggesting a typofix of the command name before
+   running that command"; now it means "yes, if there is a plausible
+   typofix for the command name, please run it immediately".
+
 
 Performance, Internal Implementation, Development Support etc.
 --------------------------------------------------------------
@@ -34,6 +47,9 @@ Performance, Internal Implementation, Development Support etc.
  * The code paths to interact with zlib has been cleaned up in
    preparation for building with zlib-ng.
 
+ * Foreign language interface for Rust into our code base has been added.
+
+
 
 Fixes since v2.48
 -----------------
@@ -151,6 +167,11 @@ Fixes since v2.48
    has been corrected.
    (merge acc4fb302b jt/gitlab-ci-base-fix later to maint).
 
+ * "git repack --keep-unreachable" to send unreachable objects to the
+   main pack "git repack -ad" produces did not work when there is no
+   existing packs, which has been corrected.
+   (merge 414c82300a ps/repack-keep-unreachable-in-unpacked-repo 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).
@@ -164,3 +185,4 @@ Fixes since v2.48
    (merge 6979bf6f8f jk/combine-diff-cleanup later to maint).
    (merge 8705c9bd13 kn/pack-write-with-reduced-globals later to maint).
    (merge 087740d65a ps/leakfixes-0129 later to maint).
+   (merge 6bba6f604b jp/doc-trailer-config later to maint).

config.txt

@@ -540,6 +540,8 @@ include::config/tar.txt[]
 
 include::config/trace2.txt[]
 
+include::config/trailer.txt[]
+
 include::config/transfer.txt[]
 
 include::config/uploadarchive.txt[]

git-config.html

@@ -5676,22 +5676,23 @@ <h3 id="_variables">Variables</h3>
 <div class="ulist">
 <ul>
 <li>
-<p>0 (default): show the suggested command.</p>
+<p>0, "false", "off", "no", "show": show the suggested command (default).</p>
 </li>
 <li>
-<p>positive number: run the suggested command after specified
+<p>1, "true", "on", "yes", "immediate": run the suggested command
+immediately.</p>
+</li>
+<li>
+<p>positive number &gt; 1: run the suggested command after specified
 deciseconds (0.1 sec).</p>
 </li>
 <li>
-<p>"immediate": run the suggested command immediately.</p>
+<p>"never": don&#8217;t run or show any suggested command.</p>
 </li>
 <li>
 <p>"prompt": show the suggestion and prompt for confirmation to run
 the command.</p>
 </li>
-<li>
-<p>"never": don&#8217;t run or show any suggested command.</p>
-</li>
 </ul>
 </div>
 </dd>
@@ -8959,6 +8960,175 @@ <h3 id="_variables">Variables</h3>
 write a sentinel file that will block further tracing to this
 directory. Defaults to 0, which disables this check.</p>
 </dd>
+<dt class="hdlist1">trailer.separators</dt>
+<dd>
+<p>This option tells which characters are recognized as trailer
+separators. By default only <em>:</em> is recognized as a trailer
+separator, except that <em>=</em> is always accepted on the command
+line for compatibility with other git commands.</p>
+<div class="paragraph">
+<p>The first character given by this option will be the default character
+used when another separator is not specified in the config for this
+trailer.</p>
+</div>
+<div class="paragraph">
+<p>For example, if the value for this option is "%=$", then only lines
+using the format <em>&lt;key&gt;&lt;sep&gt;&lt;value&gt;</em> with &lt;sep&gt; containing <em>%</em>, <em>=</em>
+or <em>$</em> and then spaces will be considered trailers. And <em>%</em> will be
+the default separator used, so by default trailers will appear like:
+<em>&lt;key&gt;% &lt;value&gt;</em> (one percent sign and one space will appear between
+the key and the value).</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.where</dt>
+<dd>
+<p>This option tells where a new trailer will be added.</p>
+<div class="paragraph">
+<p>This can be <code>end</code>, which is the default, <code>start</code>, <code>after</code> or <code>before</code>.</p>
+</div>
+<div class="paragraph">
+<p>If it is <code>end</code>, then each new trailer will appear at the end of the
+existing trailers.</p>
+</div>
+<div class="paragraph">
+<p>If it is <code>start</code>, then each new trailer will appear at the start,
+instead of the end, of the existing trailers.</p>
+</div>
+<div class="paragraph">
+<p>If it is <code>after</code>, then each new trailer will appear just after the
+last trailer with the same &lt;key&gt;.</p>
+</div>
+<div class="paragraph">
+<p>If it is <code>before</code>, then each new trailer will appear just before the
+first trailer with the same &lt;key&gt;.</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.ifexists</dt>
+<dd>
+<p>This option makes it possible to choose what action will be
+performed when there is already at least one trailer with the
+same &lt;key&gt; in the input.</p>
+<div class="paragraph">
+<p>The valid values for this option are: <code>addIfDifferentNeighbor</code> (this
+is the default), <code>addIfDifferent</code>, <code>add</code>, <code>replace</code> or <code>doNothing</code>.</p>
+</div>
+<div class="paragraph">
+<p>With <code>addIfDifferentNeighbor</code>, a new trailer will be added only if no
+trailer with the same (&lt;key&gt;, &lt;value&gt;) pair is above or below the line
+where the new trailer will be added.</p>
+</div>
+<div class="paragraph">
+<p>With <code>addIfDifferent</code>, a new trailer will be added only if no trailer
+with the same (&lt;key&gt;, &lt;value&gt;) pair is already in the input.</p>
+</div>
+<div class="paragraph">
+<p>With <code>add</code>, a new trailer will be added, even if some trailers with
+the same (&lt;key&gt;, &lt;value&gt;) pair are already in the input.</p>
+</div>
+<div class="paragraph">
+<p>With <code>replace</code>, an existing trailer with the same &lt;key&gt; will be
+deleted and the new trailer will be added. The deleted trailer will be
+the closest one (with the same &lt;key&gt;) to the place where the new one
+will be added.</p>
+</div>
+<div class="paragraph">
+<p>With <code>doNothing</code>, nothing will be done; that is no new trailer will be
+added if there is already one with the same &lt;key&gt; in the input.</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.ifmissing</dt>
+<dd>
+<p>This option makes it possible to choose what action will be
+performed when there is not yet any trailer with the same
+&lt;key&gt; in the input.</p>
+<div class="paragraph">
+<p>The valid values for this option are: <code>add</code> (this is the default) and
+<code>doNothing</code>.</p>
+</div>
+<div class="paragraph">
+<p>With <code>add</code>, a new trailer will be added.</p>
+</div>
+<div class="paragraph">
+<p>With <code>doNothing</code>, nothing will be done.</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.key</dt>
+<dd>
+<p>Defines a &lt;keyAlias&gt; for the &lt;key&gt;. The &lt;keyAlias&gt; must be a
+prefix (case does not matter) of the &lt;key&gt;. For example, in <code>git</code>
+<code>config</code> <code>trailer.ack.key</code> "Acked-by" the "Acked-by" is the &lt;key&gt; and
+the "ack" is the &lt;keyAlias&gt;. This configuration allows the shorter
+<code>--trailer</code> "ack:<code>...</code>" invocation on the command line using the "ack"
+&lt;keyAlias&gt; instead of the longer <code>--trailer</code> "Acked-by:<code>...</code>".</p>
+<div class="paragraph">
+<p>At the end of the &lt;key&gt;, a separator can appear and then some
+space characters. By default the only valid separator is <em>:</em>,
+but this can be changed using the <code>trailer.separators</code> config
+variable.</p>
+</div>
+<div class="paragraph">
+<p>If there is a separator in the key, then it overrides the default
+separator when adding the trailer.</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.where</dt>
+<dd>
+<p>This option takes the same values as the <em>trailer.where</em>
+configuration variable and it overrides what is specified by
+that option for trailers with the specified &lt;keyAlias&gt;.</p>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.ifexists</dt>
+<dd>
+<p>This option takes the same values as the <em>trailer.ifexists</em>
+configuration variable and it overrides what is specified by
+that option for trailers with the specified &lt;keyAlias&gt;.</p>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.ifmissing</dt>
+<dd>
+<p>This option takes the same values as the <em>trailer.ifmissing</em>
+configuration variable and it overrides what is specified by
+that option for trailers with the specified &lt;keyAlias&gt;.</p>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.command</dt>
+<dd>
+<p>Deprecated in favor of <em>trailer.&lt;keyAlias&gt;.cmd</em>.
+This option behaves in the same way as <em>trailer.&lt;keyAlias&gt;.cmd</em>, except
+that it doesn&#8217;t pass anything as argument to the specified command.
+Instead the first occurrence of substring $ARG is replaced by the
+&lt;value&gt; that would be passed as argument.</p>
+<div class="paragraph">
+<p>Note that $ARG in the user&#8217;s command is
+only replaced once and that the original way of replacing $ARG is not safe.</p>
+</div>
+<div class="paragraph">
+<p>When both <em>trailer.&lt;keyAlias&gt;.cmd</em> and <em>trailer.&lt;keyAlias&gt;.command</em> are given
+for the same &lt;keyAlias&gt;, <em>trailer.&lt;keyAlias&gt;.cmd</em> is used and
+<em>trailer.&lt;keyAlias&gt;.command</em> is ignored.</p>
+</div>
+</dd>
+<dt class="hdlist1">trailer.&lt;keyAlias&gt;.cmd</dt>
+<dd>
+<p>This option can be used to specify a shell command that will be called
+once to automatically add a trailer with the specified &lt;keyAlias&gt;, and then
+called each time a <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument is specified to
+modify the &lt;value&gt; of the trailer that this option would produce.</p>
+<div class="paragraph">
+<p>When the specified command is first called to add a trailer
+with the specified &lt;keyAlias&gt;, the behavior is as if a special
+<em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument was added at the beginning
+of the "git interpret-trailers" command, where &lt;value&gt;
+is taken to be the standard output of the command with any
+leading and trailing whitespace trimmed off.</p>
+</div>
+<div class="paragraph">
+<p>If some <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> arguments are also passed
+on the command line, the command is called again once for each
+of these arguments with the same &lt;keyAlias&gt;. And the &lt;value&gt; part
+of these arguments, if any, will be passed to the command as its
+first argument. This way the command can produce a &lt;value&gt; computed
+from the &lt;value&gt; passed in the <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument.</p>
+</div>
+</dd>
 <dt class="hdlist1">transfer.credentialsInUrl</dt>
 <dd>
 <p>A configured URL can contain plaintext credentials in the form

git-gc.html

@@ -528,6 +528,14 @@ <h2 id="_options">OPTIONS</h2>
 the <code>--max-cruft-size</code> option of <a href="git-repack.html">git-repack(1)</a> for
 more.</p>
 </dd>
+<dt class="hdlist1">--expire-to=&lt;dir&gt;</dt>
+<dd>
+<p>When packing unreachable objects into a cruft pack, write a cruft
+pack containing pruned objects (if any) to the directory <em>&lt;dir&gt;</em>.
+This option only has an effect when used together with <code>--cruft</code>.
+See the <code>--expire-to</code> option of <a href="git-repack.html">git-repack(1)</a> for
+more information.</p>
+</dd>
 <dt class="hdlist1">--prune=&lt;date&gt;</dt>
 <dd>
 <p>Prune loose objects older than date (default is 2 weeks ago,
@@ -892,7 +900,7 @@ <h2 id="_git">GIT</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-26 15:45:16 -0700
+Last updated 2025-02-12 10:11:31 -0800
 </div>
 </div>
 </body>

git-gc.txt

@@ -69,6 +69,13 @@ be performed as well.
 	the `--max-cruft-size` option of linkgit:git-repack[1] for
 	more.
 
+--expire-to=<dir>::
+	When packing unreachable objects into a cruft pack, write a cruft
+	pack containing pruned objects (if any) to the directory `<dir>`.
+	This option only has an effect when used together with `--cruft`.
+	See the `--expire-to` option of linkgit:git-repack[1] for
+	more information.
+
 --prune=<date>::
 	Prune loose objects older than date (default is 2 weeks ago,
 	overridable by the config variable `gc.pruneExpire`).

git-interpret-trailers.html

@@ -670,6 +670,11 @@ <h2 id="_options">OPTIONS</h2>
 <div class="sect1">
 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 <div class="sectionbody">
+<div class="paragraph">
+<p>Everything below this line in this section is selectively included
+from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
+as what&#8217;s found there:</p>
+</div>
 <div class="dlist">
 <dl>
 <dt class="hdlist1">trailer.separators</dt>
@@ -1079,7 +1084,7 @@ <h2 id="_git">GIT</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-03-25 17:24:49 -0700
+Last updated 2025-02-12 10:11:31 -0800
 </div>
 </div>
 </body>