Skip to content

Commit

Permalink
Autogenerated HTML docs for v2.46.0-421-g159f2
Browse files Browse the repository at this point in the history
  • Loading branch information
gitster committed Aug 26, 2024
1 parent f8d833a commit 51e120e
Show file tree
Hide file tree
Showing 54 changed files with 253 additions and 82 deletions.
2 changes: 1 addition & 1 deletion DecisionMaking.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>Decision-Making Process in the Git Project</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
2 changes: 1 addition & 1 deletion MyFirstContribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>My First Contribution to the Git Project</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
2 changes: 1 addition & 1 deletion MyFirstObjectWalk.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>My First Object Walk</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
22 changes: 22 additions & 0 deletions RelNotes/2.46.1.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,26 @@ Fixes since Git 2.46

* Perforce tests have been updated.

* The credential helper to talk to OSX keychain sometimes sent
garbage bytes after the username, which has been corrected.

* A recent update broke "git ls-remote" used outside a repository,
which has been corrected.

* "git config --value=foo --fixed-value section.key newvalue" barfed
when the existing value in the configuration file used the
valueless true syntax, which has been corrected.

* "git reflog expire" failed to honor annotated tags when computing
reachable commits.

* A flakey test and incorrect calls to strtoX() functions have been
fixed.

* Follow-up on 2.45.1 regression fix.

* "git rev-list ... | git diff-tree -p --remerge-diff --stdin" should
behave more or less like "git log -p --remerge-diff" but instead it
crashed, forgetting to prepare a temporary object store needed.

Also contains minor documentation updates and code clean-ups.
36 changes: 21 additions & 15 deletions RelNotes/2.47.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ UI, Workflows & Features
environment variables, but now they can be configured in the user's
global and system wide configuration.

* "git send-email" learned "--translate-aliases" option that reads
addresses from the standard input and emits the result of applying
aliases on them to the standard output.

* 'git for-each-ref' learned a new "--format" atom to find the branch
that the history leading to a given commit "%(is-base:<commit>)" is
likely based on.


Performance, Internal Implementation, Development Support etc.
--------------------------------------------------------------
Expand Down Expand Up @@ -85,6 +93,10 @@ Performance, Internal Implementation, Development Support etc.
object in the config subsystem has been rewritten to pass a
repository object through the callchain.

* Drop unused parameters from functions.

* Mark unused parameters as UNUSED to squelch -Wunused warnings.


Fixes since v2.46
-----------------
Expand Down Expand Up @@ -118,11 +130,9 @@ Fixes since v2.46

* The credential helper to talk to OSX keychain sometimes sent
garbage bytes after the username, which has been corrected.
(merge b201316835 jk/osxkeychain-username-is-nul-terminated later to maint).

* A recent update broke "git ls-remote" used outside a repository,
which has been corrected.
(merge 9e89dcb66a ps/ls-remote-out-of-repo-fix later to maint).

* The patch parser in 'git apply' has been a bit more lenient against
unexpected mode bits, like 100664, recorded on extended header lines.
Expand All @@ -131,7 +141,6 @@ Fixes since v2.46
* "git config --value=foo --fixed-value section.key newvalue" barfed
when the existing value in the configuration file used the
valueless true syntax, which has been corrected.
(merge 615d2de3b4 tb/config-fixed-value-with-valueless-true later to maint).

* The patch parser in "git patch-id" has been tightened to avoid
getting confused by lines that look like a patch header in the log
Expand All @@ -140,35 +149,32 @@ Fixes since v2.46

* "git reflog expire" failed to honor annotated tags when computing
reachable commits.
(merge 5133ead528 jc/reflog-expire-lookup-commit-fix later to maint).

* A flakey test and incorrect calls to strtoX() functions have been
fixed.
(merge ec60bb9fc4 kl/test-fixes later to maint).

* Follow-up on 2.45.1 regression fix.
(merge ee0be850b0 jc/safe-directory later to maint).

* "git rev-list ... | git diff-tree -p --remerge-diff --stdin" should
behave more or less like "git log -p --remerge-diff" but instead it
crashed, forgetting to prepare a temporary object store needed.
(merge a77554ea09 xx/diff-tree-remerge-diff-fix later to maint).

* "git bundle unbundle" outside a repository triggered a BUG()
unnecessarily, which has been corrected.
(merge 96a9a3e42e ps/bundle-outside-repo-fix later to maint).

* Maintenance tasks other than "gc" now properly go background when
"git maintenance" runs them.

* We created a useless pseudo-merge reachability bitmap that is about
0 commits, and attempted to include commits that are not in packs,
which made no sense. These bugs have been corrected.
(merge a72dfab8b8 tb/pseudo-merge-bitmap-fixes later to maint).

* Other code cleanup, docfix, build fix, etc.
(merge bb0498b1bb jc/how-to-maintain-updates later to maint).
(merge 7c7516b8db jc/jl-git-no-advice-fix later to maint).
(merge c3d034df16 jc/leakfix-hashfile later to maint).
(merge d98d9c77e5 jc/leakfix-mailmap later to maint).
(merge c199707496 jr/ls-files-expand-literal-doc later to maint).
(merge e2e373ba82 ss/packed-ref-store-leakfix later to maint).
(merge 0c4d5aa22d rs/use-decimal-width later to maint).
(merge 67be8c4de5 jc/document-use-of-local later to maint).
(merge 098be29f5b rs/t-example-simplify later to maint).
(merge 0d66f601a9 jc/tests-no-useless-tee later to maint).
(merge 170cdfc5a4 jc/grammo-fixes later to maint).
(merge 983555a1f2 jc/how-to-maintain-updates later to maint).
(merge e3209bd4df ps/stash-keep-untrack-empty-fix later to maint).
(merge 44db6f75cc jc/coding-style-c-operator-with-spaces later to maint).
2 changes: 1 addition & 1 deletion ReviewingGuidelines.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>Reviewing Patches in the Git Project</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
2 changes: 1 addition & 1 deletion SubmittingPatches.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>Submitting Patches</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
2 changes: 1 addition & 1 deletion ToolsForGit.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>Tools for developing Git</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
2 changes: 1 addition & 1 deletion everyday.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>Everyday Git With 20 Commands Or So</h1>
<div class="details">
<span id="revdate">2024-08-23</span>
<span id="revdate">2024-08-26</span>
</div>
</div>
<div id="content">
Expand Down
16 changes: 15 additions & 1 deletion git-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -5023,7 +5023,8 @@ <h3 id="_variables">Variables</h3>
<dt class="hdlist1">gc.autoDetach</dt>
<dd>
<p>Make <code>git gc --auto</code> return immediately and run in the background
if the system supports it. Default is true.</p>
if the system supports it. Default is true. This config variable acts
as a fallback in case <code>maintenance.autoDetach</code> is not set.</p>
</dd>
<dt class="hdlist1">gc.bigPackThreshold</dt>
<dd>
Expand Down Expand Up @@ -6399,6 +6400,19 @@ <h3 id="_variables">Variables</h3>
<code>git maintenance run --auto</code> after doing their normal work. Defaults
to true.</p>
</dd>
<dt class="hdlist1">maintenance.autoDetach</dt>
<dd>
<p>Many Git commands trigger automatic maintenance after they have
written data into the repository. This boolean config option
controls whether this automatic maintenance shall happen in the
foreground or whether the maintenance process shall detach and
continue to run in the background.</p>
<div class="paragraph">
<p>If unset, the value of <code>gc.autoDetach</code> is used as a fallback. Defaults
to true if both are unset, meaning that the maintenance process will
detach.</p>
</div>
</dd>
<dt class="hdlist1">maintenance.strategy</dt>
<dd>
<p>This string config option provides a way to specify one of a few
Expand Down
51 changes: 50 additions & 1 deletion git-for-each-ref.html
Original file line number Diff line number Diff line change
Expand Up @@ -766,6 +766,55 @@ <h2 id="_field_names">FIELD NAMES</h2>
commits ahead and behind, respectively, when comparing the output
ref to the <code>&lt;committish&gt;</code> specified in the format.</p>
</dd>
<dt class="hdlist1">is-base:&lt;committish&gt;</dt>
<dd>
<p>In at most one row, <code>(&lt;committish&gt;)</code> will appear to indicate the ref
that is most likely the ref used as a starting point for the branch
that produced <code>&lt;committish&gt;</code>. This choice is made using a heuristic:
choose the ref that minimizes the number of commits in the
first-parent history of <code>&lt;committish&gt;</code> and not in the first-parent
history of the ref.</p>
<div class="paragraph">
<p>For example, consider the following figure of first-parent histories of
several refs:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>*--*--*--*--*--* refs/heads/A
\
\
*--*--*--* refs/heads/B
\ \
\ \
* * refs/heads/C
\
\
*--* refs/heads/D</pre>
</div>
</div>
<div class="paragraph">
<p>Here, if <code>A</code>, <code>B</code>, and <code>C</code> are the filtered references, and the format
string is <code>%(refname):%(is-base:D)</code>, then the output would be</p>
</div>
<div class="listingblock">
<div class="content">
<pre>refs/heads/A:
refs/heads/B:(D)
refs/heads/C:</pre>
</div>
</div>
<div class="paragraph">
<p>This is because the first-parent history of <code>D</code> has its earliest
intersection with the first-parent histories of the filtered refs at a
common first-parent ancestor of <code>B</code> and <code>C</code> and ties are broken by the
earliest ref in the sorted order.</p>
</div>
<div class="paragraph">
<p>Note that this token will not appear if the first-parent history of
<code>&lt;committish&gt;</code> does not intersect the first-parent histories of the
filtered refs.</p>
</div>
</dd>
<dt class="hdlist1">describe[:options]</dt>
<dd>
<p>A human-readable name, like <a href="git-describe.html">git-describe(1)</a>;
Expand Down Expand Up @@ -1088,7 +1137,7 @@ <h2 id="_git">GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-03-05 10:14:09 -0800
Last updated 2024-08-26 15:45:16 -0700
</div>
</div>
</body>
Expand Down
42 changes: 42 additions & 0 deletions git-for-each-ref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,48 @@ ahead-behind:<committish>::
commits ahead and behind, respectively, when comparing the output
ref to the `<committish>` specified in the format.

is-base:<committish>::
In at most one row, `(<committish>)` will appear to indicate the ref
that is most likely the ref used as a starting point for the branch
that produced `<committish>`. This choice is made using a heuristic:
choose the ref that minimizes the number of commits in the
first-parent history of `<committish>` and not in the first-parent
history of the ref.
+
For example, consider the following figure of first-parent histories of
several refs:
+
----
*--*--*--*--*--* refs/heads/A
\
\
*--*--*--* refs/heads/B
\ \
\ \
* * refs/heads/C
\
\
*--* refs/heads/D
----
+
Here, if `A`, `B`, and `C` are the filtered references, and the format
string is `%(refname):%(is-base:D)`, then the output would be
+
----
refs/heads/A:
refs/heads/B:(D)
refs/heads/C:
----
+
This is because the first-parent history of `D` has its earliest
intersection with the first-parent histories of the filtered refs at a
common first-parent ancestor of `B` and `C` and ties are broken by the
earliest ref in the sorted order.
+
Note that this token will not appear if the first-parent history of
`<committish>` does not intersect the first-parent histories of the
filtered refs.

describe[:options]::
A human-readable name, like linkgit:git-describe[1];
empty string for undescribable commits. The `describe` string may
Expand Down
12 changes: 9 additions & 3 deletions git-gc.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ <h2 id="_name">NAME</h2>
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>git gc</em> [--aggressive] [--auto] [--quiet] [--prune=&lt;date&gt; | --no-prune] [--force] [--keep-largest-pack]</pre>
<pre class="content"><em>git gc</em> [--aggressive] [--auto] [--[no-]detach] [--quiet] [--prune=&lt;date&gt; | --no-prune] [--force] [--keep-largest-pack]</pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -509,6 +509,11 @@ <h2 id="_options">OPTIONS</h2>
be performed as well.</p>
</div>
</dd>
<dt class="hdlist1">--[no-]detach</dt>
<dd>
<p>Run in the background if the system supports it. This option overrides
the <code>gc.autoDetach</code> config.</p>
</dd>
<dt class="hdlist1">--[no-]cruft</dt>
<dd>
<p>When expiring unreachable objects, pack them separately into a
Expand Down Expand Up @@ -649,7 +654,8 @@ <h2 id="_configuration">CONFIGURATION</h2>
<dt class="hdlist1">gc.autoDetach</dt>
<dd>
<p>Make <code>git gc --auto</code> return immediately and run in the background
if the system supports it. Default is true.</p>
if the system supports it. Default is true. This config variable acts
as a fallback in case <code>maintenance.autoDetach</code> is not set.</p>
</dd>
<dt class="hdlist1">gc.bigPackThreshold</dt>
<dd>
Expand Down Expand Up @@ -886,7 +892,7 @@ <h2 id="_git">GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-10-18 13:44:22 -0700
Last updated 2024-08-26 15:45:16 -0700
</div>
</div>
</body>
Expand Down
5 changes: 4 additions & 1 deletion git-gc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository
SYNOPSIS
--------
[verse]
'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack]
'git gc' [--aggressive] [--auto] [--[no-]detach] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack]

DESCRIPTION
-----------
Expand Down Expand Up @@ -53,6 +53,9 @@ configuration options such as `gc.auto` and `gc.autoPackLimit`, all
other housekeeping tasks (e.g. rerere, working trees, reflog...) will
be performed as well.

--[no-]detach::
Run in the background if the system supports it. This option overrides
the `gc.autoDetach` config.

--[no-]cruft::
When expiring unreachable objects, pack them separately into a
Expand Down
Loading

0 comments on commit 51e120e

Please sign in to comment.