Autogenerated HTML docs for v2.42.0-411-g813d9

git · Oct 18, 2023 · 362e04f · 362e04f
1 parent c05b764
commit 362e04f
Show file tree

Hide file tree

Showing 56 changed files with 179 additions and 108 deletions.
diff --git a/MyFirstContribution.html b/MyFirstContribution.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>My First Contribution to the Git Project</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div class="sect1">

diff --git a/MyFirstObjectWalk.html b/MyFirstObjectWalk.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>My First Object Walk</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div class="sect1">

diff --git a/RelNotes/2.43.0.txt b/RelNotes/2.43.0.txt
@@ -86,7 +86,8 @@ UI, Workflows & Features
  * "git repack" machinery learns to pay attention to the "--filter="
    option.
 
- * Test coverage for trailers has been improved.
+ * "git repack" learned "--max-cruft-size" to prevent cruft packs from
+   growing without bounds.
 
 
 Performance, Internal Implementation, Development Support etc.
@@ -123,6 +124,8 @@ Performance, Internal Implementation, Development Support etc.
  * GitHub CI workflow has learned to trigger Coverity check.
    (merge 3349520e1a js/ci-coverity later to maint).
 
+ * Test coverage for trailers has been improved.
+
 
 Fixes since v2.42
 -----------------
@@ -243,6 +246,10 @@ Fixes since v2.42
    corrected.
    (merge 4adceb5a29 ar/diff-index-merge-base-fix later to maint).
 
+ * Fix "git merge-tree" to stop segfaulting when the --attr-source
+   option is used.
+   (merge e95bafc52f jc/merge-ort-attr-index-fix later to maint).
+
  * Other code cleanup, docfix, build fix, etc.
    (merge fd3ba590d8 ws/git-push-doc-grammofix later to maint).
    (merge 5f33a843de ds/upload-pack-error-sequence-fix later to maint).
@@ -266,3 +273,4 @@ Fixes since v2.42
    (merge c2c349a15c xz/commit-title-soft-limit-doc later to maint).
    (merge f4cbb32c27 rs/parse-opt-ctx-cleanup later to maint).
    (merge badf2fe1c3 jk/decoration-and-other-leak-fixes later to maint).
+   (merge cebfaaa333 sn/cat-file-doc-update later to maint).
diff --git a/ReviewingGuidelines.html b/ReviewingGuidelines.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>Reviewing Patches in the Git Project</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div class="sect1">

diff --git a/SubmittingPatches.html b/SubmittingPatches.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>Submitting Patches</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div class="sect1">

diff --git a/ToolsForGit.html b/ToolsForGit.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>Tools for developing Git</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div class="sect1">

diff --git a/cmds-plumbinginterrogators.txt b/cmds-plumbinginterrogators.txt
@@ -1,5 +1,5 @@
 linkgit:git-cat-file[1]::
-	Provide content or type and size information for repository objects.
+	Provide contents or details of repository objects.
 
 linkgit:git-cherry[1]::
 	Find commits yet to be applied to upstream.

diff --git a/everyday.html b/everyday.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>Everyday Git With 20 Commands Or So</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div id="preamble">

diff --git a/git-cat-file.html b/git-cat-file.html
@@ -740,7 +740,7 @@ <h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-cat-file -
-   Provide content or type and size information for repository objects
+   Provide contents or details of repository objects
 </p>
 </div>
 </div>
@@ -752,28 +752,25 @@ <h2 id="_synopsis">SYNOPSIS</h2>
 <pre class="content"><em>git cat-file</em> &lt;type&gt; &lt;object&gt;
 <em>git cat-file</em> (-e | -p) &lt;object&gt;
 <em>git cat-file</em> (-t | -s) [--allow-unknown-type] &lt;object&gt;
+<em>git cat-file</em> (--textconv | --filters)
+             [&lt;rev&gt;:&lt;path|tree-ish&gt; | --path=&lt;path|tree-ish&gt; &lt;rev&gt;]
 <em>git cat-file</em> (--batch | --batch-check | --batch-command) [--batch-all-objects]
              [--buffer] [--follow-symlinks] [--unordered]
-             [--textconv | --filters] [-Z]
-<em>git cat-file</em> (--textconv | --filters)
-             [&lt;rev&gt;:&lt;path|tree-ish&gt; | --path=&lt;path|tree-ish&gt; &lt;rev&gt;]</pre>
+             [--textconv | --filters] [-Z]</pre>
 <div class="attribution">
 </div></div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_description">DESCRIPTION</h2>
 <div class="sectionbody">
-<div class="paragraph"><p>In its first form, the command provides the content or the type of an object in
-the repository. The type is required unless <code>-t</code> or <code>-p</code> is used to find the
-object type, or <code>-s</code> is used to find the object size, or <code>--textconv</code> or
-<code>--filters</code> is used (which imply type "blob").</p></div>
-<div class="paragraph"><p>In the second form, a list of objects (separated by linefeeds) is provided on
-stdin, and the SHA-1, type, and size of each object is printed on stdout. The
-output format can be overridden using the optional <code>&lt;format&gt;</code> argument. If
-either <code>--textconv</code> or <code>--filters</code> was specified, the input is expected to
-list the object names followed by the path name, separated by a single
-whitespace, so that the appropriate drivers can be determined.</p></div>
+<div class="paragraph"><p>Output the contents or other properties such as size, type or delta
+information of one or more objects.</p></div>
+<div class="paragraph"><p>This command can operate in two modes, depending on whether an option
+from the <code>--batch</code> family is specified.</p></div>
+<div class="paragraph"><p>In non-batch mode, the command provides information on an object
+named on the command line.</p></div>
+<div class="paragraph"><p>In batch mode, arguments are read from standard input.</p></div>
 </div>
 </div>
 <div class="sect1">
@@ -816,8 +813,8 @@ <h2 id="_options">OPTIONS</h2>
 <dd>
 <p>
         Exit with zero status if <code>&lt;object&gt;</code> exists and is a valid
-        object. If <code>&lt;object&gt;</code> is of an invalid format exit with non-zero and
-        emits an error on stderr.
+        object. If <code>&lt;object&gt;</code> is of an invalid format, exit with non-zero
+        status and emit an error on stderr.
 </p>
 </dd>
 <dt class="hdlist1">
@@ -1345,7 +1342,7 @@ <h2 id="_git">GIT</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-06-23 13:24:09 PDT
+ 2023-10-18 13:44:22 PDT
 </div>
 </div>
 </body>

diff --git a/git-cat-file.txt b/git-cat-file.txt
@@ -3,34 +3,32 @@ git-cat-file(1)
 
 NAME
 ----
-git-cat-file - Provide content or type and size information for repository objects
-
+git-cat-file - Provide contents or details of repository objects
 
 SYNOPSIS
 --------
 [verse]
 'git cat-file' <type> <object>
 'git cat-file' (-e | -p) <object>
 'git cat-file' (-t | -s) [--allow-unknown-type] <object>
+'git cat-file' (--textconv | --filters)
+	     [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>]
 'git cat-file' (--batch | --batch-check | --batch-command) [--batch-all-objects]
 	     [--buffer] [--follow-symlinks] [--unordered]
 	     [--textconv | --filters] [-Z]
-'git cat-file' (--textconv | --filters)
-	     [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>]
 
 DESCRIPTION
 -----------
-In its first form, the command provides the content or the type of an object in
-the repository. The type is required unless `-t` or `-p` is used to find the
-object type, or `-s` is used to find the object size, or `--textconv` or
-`--filters` is used (which imply type "blob").
-
-In the second form, a list of objects (separated by linefeeds) is provided on
-stdin, and the SHA-1, type, and size of each object is printed on stdout. The
-output format can be overridden using the optional `<format>` argument. If
-either `--textconv` or `--filters` was specified, the input is expected to
-list the object names followed by the path name, separated by a single
-whitespace, so that the appropriate drivers can be determined.
+Output the contents or other properties such as size, type or delta
+information of one or more objects.
+
+This command can operate in two modes, depending on whether an option
+from the `--batch` family is specified.
+
+In non-batch mode, the command provides information on an object
+named on the command line.
+
+In batch mode, arguments are read from standard input.
 
 OPTIONS
 -------
@@ -51,8 +49,8 @@ OPTIONS
 
 -e::
 	Exit with zero status if `<object>` exists and is a valid
-	object. If `<object>` is of an invalid format exit with non-zero and
-	emits an error on stderr.
+	object. If `<object>` is of an invalid format, exit with non-zero
+	status and emit an error on stderr.
 
 -p::
 	Pretty-print the contents of `<object>` based on its type.

diff --git a/git-config.html b/git-config.html
@@ -6200,6 +6200,17 @@ <h3 id="_variables">Variables</h3>
 </p>
 </dd>
 <dt class="hdlist1">
+gc.maxCruftSize
+</dt>
+<dd>
+<p>
+        Limit the size of new cruft packs when repacking. When
+        specified in addition to <code>--max-cruft-size</code>, the command line
+        option takes priority. See the <code>--max-cruft-size</code> option of
+        <a href="git-repack.html">git-repack(1)</a>.
+</p>
+</dd>
+<dt class="hdlist1">
 gc.pruneExpire
 </dt>
 <dd>

diff --git a/git-gc.html b/git-gc.html
@@ -816,6 +816,18 @@ <h2 id="_options">OPTIONS</h2>
 </p>
 </dd>
 <dt class="hdlist1">
+--max-cruft-size=&lt;n&gt;
+</dt>
+<dd>
+<p>
+        When packing unreachable objects into a cruft pack, limit the
+        size of new cruft packs to be at most <code>&lt;n&gt;</code> bytes. Overrides any
+        value specified via the <code>gc.maxCruftSize</code> configuration. See
+        the <code>--max-cruft-size</code> option of <a href="git-repack.html">git-repack(1)</a> for
+        more.
+</p>
+</dd>
+<dt class="hdlist1">
 --prune=&lt;date&gt;
 </dt>
 <dd>
@@ -1031,6 +1043,17 @@ <h2 id="_configuration">CONFIGURATION</h2>
 </p>
 </dd>
 <dt class="hdlist1">
+gc.maxCruftSize
+</dt>
+<dd>
+<p>
+        Limit the size of new cruft packs when repacking. When
+        specified in addition to <code>--max-cruft-size</code>, the command line
+        option takes priority. See the <code>--max-cruft-size</code> option of
+        <a href="git-repack.html">git-repack(1)</a>.
+</p>
+</dd>
+<dt class="hdlist1">
 gc.pruneExpire
 </dt>
 <dd>
@@ -1234,7 +1257,7 @@ <h2 id="_git">GIT</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-04-28 16:26:53 PDT
+ 2023-10-18 13:44:22 PDT
 </div>
 </div>
 </body>

diff --git a/git-gc.txt b/git-gc.txt
@@ -59,6 +59,13 @@ be performed as well.
 	cruft pack instead of storing them as loose objects. `--cruft`
 	is on by default.
 
+--max-cruft-size=<n>::
+	When packing unreachable objects into a cruft pack, limit the
+	size of new cruft packs to be at most `<n>` bytes. Overrides any
+	value specified via the `gc.maxCruftSize` configuration. See
+	the `--max-cruft-size` option of linkgit:git-repack[1] for
+	more.
+
 --prune=<date>::
 	Prune loose objects older than date (default is 2 weeks ago,
 	overridable by the config variable `gc.pruneExpire`).

diff --git a/git-remote-helpers.html b/git-remote-helpers.html
@@ -735,7 +735,7 @@
 <body class="article">
 <div id="header">
 <h1>git-remote-helpers</h1>
-<span id="revdate">2023-10-13</span>
+<span id="revdate">2023-10-18</span>
 </div>
 <div id="content">
 <div id="preamble">

diff --git a/git-repack.html b/git-repack.html
@@ -841,6 +841,22 @@ <h2 id="_options">OPTIONS</h2>
 </p>
 </dd>
 <dt class="hdlist1">
+--max-cruft-size=&lt;n&gt;
+</dt>
+<dd>
+<p>
+        Repack cruft objects into packs as large as <code>&lt;n&gt;</code> bytes before
+        creating new packs. As long as there are enough cruft packs
+        smaller than <code>&lt;n&gt;</code>, repacking will cause a new cruft pack to
+        be created containing objects from any combined cruft packs,
+        along with any new unreachable objects. Cruft packs larger than
+        <code>&lt;n&gt;</code> will not be modified. When the new cruft pack is larger
+        than <code>&lt;n&gt;</code> bytes, it will be split into multiple packs, all of
+        which are guaranteed to be at most <code>&lt;n&gt;</code> bytes in size. Only
+        useful with <code>--cruft -d</code>.
+</p>
+</dd>
+<dt class="hdlist1">
 --expire-to=&lt;dir&gt;
 </dt>
 <dd>
@@ -1156,7 +1172,7 @@ <h2 id="_git">GIT</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-10-10 11:55:22 PDT
+ 2023-10-18 13:44:22 PDT
 </div>
 </div>
 </body>

diff --git a/git-repack.txt b/git-repack.txt
@@ -74,6 +74,17 @@ to the new separate pack will be written.
 	immediately instead of waiting for the next `git gc` invocation.
 	Only useful with `--cruft -d`.
 
+--max-cruft-size=<n>::
+	Repack cruft objects into packs as large as `<n>` bytes before
+	creating new packs. As long as there are enough cruft packs
+	smaller than `<n>`, repacking will cause a new cruft pack to
+	be created containing objects from any combined cruft packs,
+	along with any new unreachable objects. Cruft packs larger than
+	`<n>` will not be modified. When the new cruft pack is larger
+	than `<n>` bytes, it will be split into multiple packs, all of
+	which are guaranteed to be at most `<n>` bytes in size. Only
+	useful with `--cruft -d`.
+
 --expire-to=<dir>::
 	Write a cruft pack containing pruned objects (if any) to the
 	directory `<dir>`. This option is useful for keeping a copy of

diff --git a/git.html b/git.html
@@ -1985,7 +1985,7 @@ <h3 id="_interrogation_commands">Interrogation commands</h3>
 </dt>
 <dd>
 <p>
-        Provide content or type and size information for repository objects.
+        Provide contents or details of repository objects.
 </p>
 </dd>
 <dt class="hdlist1">

diff --git a/gittutorial.html b/gittutorial.html
@@ -864,10 +864,10 @@ <h2 id="_making_changes">Making changes</h2>
 <div class="paragraph"><p>which will automatically notice any modified (but not new) files, add
 them to the index, and commit, all in one step.</p></div>
 <div class="paragraph"><p>A note on commit messages: Though not required, it&#8217;s a good idea to
-begin the commit message with a single short (less than 50 character)
-line summarizing the change, followed by a blank line and then a more
-thorough description. The text up to the first blank line in a commit
-message is treated as the commit title, and that title is used
+begin the commit message with a single short (no more than 50
+characters) line summarizing the change, followed by a blank line and
+then a more thorough description. The text up to the first blank line in
+a commit message is treated as the commit title, and that title is used
 throughout Git.  For example, <a href="git-format-patch.html">git-format-patch(1)</a> turns a
 commit into email, and it uses the title on the Subject line and the
 rest of the commit in the body.</p></div>
@@ -1374,7 +1374,7 @@ <h2 id="_git">GIT</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-05-10 11:57:07 PDT
+ 2023-10-18 13:44:22 PDT
 </div>
 </div>
 </body>
-Original file line number
+Diff line change
@@ Expand Up @@
     </dt>
     <dd>
     <p>
-            Provide content or type and size information for repository objects.
+            Provide contents or details of repository objects.
     </p>
     </dd>
     <dt class="hdlist1">
@@ Expand Down @@