Skip to content

Commit 8a42471

Browse files
committed
Autogenerated HTML docs for v2.47.0-365-gcc01ba
1 parent f3e22b3 commit 8a42471

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+222
-82
lines changed

DecisionMaking.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>Decision-Making Process in the Git Project</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

MyFirstContribution.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>My First Contribution to the Git Project</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

MyFirstObjectWalk.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>My First Object Walk</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

RelNotes/2.48.0.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ UI, Workflows & Features
1616
* Teach 'git notes add' and 'git notes append' a new '-e' flag,
1717
instructing them to open the note in $GIT_EDITOR before saving.
1818

19+
* Documentation for "git bundle" saw improvements to more prominently
20+
call out the use of '--all' when creating bundles.
21+
1922

2023
Performance, Internal Implementation, Development Support etc.
2124
--------------------------------------------------------------
@@ -82,6 +85,15 @@ Performance, Internal Implementation, Development Support etc.
8285

8386
* Renaming a handful of variables and structure fields.
8487

88+
* Fix for clar unit tests to support CMake build.
89+
90+
* C23 compatibility updates.
91+
92+
* GCC 15 compatibility updates.
93+
94+
* We now ensure "index-pack" is used with the "--promisor" option
95+
only during a "git fetch".
96+
8597

8698
Fixes since v2.47
8799
-----------------
@@ -159,6 +171,14 @@ Fixes since v2.47
159171
of object.
160172
(merge e199290592 tb/multi-pack-reuse-dupfix later to maint).
161173

174+
* "git fast-import" can be tricked into a replace ref that maps an
175+
object to itself, which is a useless thing to do.
176+
(merge 5e904f1a4a en/fast-import-avoid-self-replace later to maint).
177+
178+
* The ref-transaction hook triggered for reflog updates, which has
179+
been corrected.
180+
(merge b886db48c6 kn/ref-transaction-hook-with-reflog later to maint).
181+
162182
* Other code cleanup, docfix, build fix, etc.
163183
(merge 1164e270b5 jk/output-prefix-cleanup later to maint).
164184
(merge f36b8cbaef jh/config-unset-doc-fix later to maint).
@@ -172,3 +192,4 @@ Fixes since v2.47
172192
(merge f1ed39987b xx/protocol-v2-doc-markup-fix later to maint).
173193
(merge 41869f7447 ak/typofixes later to maint).
174194
(merge dcd590a39d bf/t-readme-mention-reftable later to maint).
195+
(merge 68e3c69efa kh/trailer-in-glossary later to maint).

ReviewingGuidelines.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>Reviewing Patches in the Git Project</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

SubmittingPatches.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>Submitting Patches</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

ToolsForGit.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>Tools for developing Git</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

everyday.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>Everyday Git With 20 Commands Or So</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

git-bundle.html

Lines changed: 70 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -469,8 +469,9 @@ <h2 id="_description">DESCRIPTION</h2>
469469
</div>
470470
<div class="paragraph">
471471
<p>They can be used to create both incremental and full backups of a
472-
repository, and to relay the state of the references in one repository
473-
to another.</p>
472+
repository (see the "full backup" example in "EXAMPLES"), and to relay
473+
the state of the references in one repository to another (see the second
474+
example).</p>
474475
</div>
475476
<div class="paragraph">
476477
<p>Git commands that fetch or otherwise "read" via protocols such as
@@ -481,9 +482,6 @@ <h2 id="_description">DESCRIPTION</h2>
481482
corresponding "write" support, i.e.a <em>git push</em> into a bundle is not
482483
supported.</p>
483484
</div>
484-
<div class="paragraph">
485-
<p>See the "EXAMPLES" section below for examples of how to use bundles.</p>
486-
</div>
487485
</div>
488486
</div>
489487
<div class="sect1">
@@ -604,7 +602,7 @@ <h2 id="_specifying_references">SPECIFYING REFERENCES</h2>
604602
<div class="sectionbody">
605603
<div class="paragraph">
606604
<p>Revisions must be accompanied by reference names to be packaged in a
607-
bundle.</p>
605+
bundle. Alternatively <code>--all</code> can be used to package all refs.</p>
608606
</div>
609607
<div class="paragraph">
610608
<p>More than one reference may be packaged, and more than one set of prerequisite objects can
@@ -693,9 +691,7 @@ <h2 id="_object_prerequisites">OBJECT PREREQUISITES</h2>
693691
when unpacking at the destination.</p>
694692
</div>
695693
<div class="paragraph">
696-
<p>If you want to match <code>git</code> <code>clone</code> <code>--mirror</code>, which would include your
697-
refs such as <code>refs/remotes/</code>*, use <code>--all</code>.
698-
If you want to provide the same set of refs that a clone directly
694+
<p>If you want to provide the same set of refs that a clone directly
699695
from the source repository would get, use <code>--branches</code> <code>--tags</code> for
700696
the <em>&lt;git-rev-list-args&gt;</em>.</p>
701697
</div>
@@ -710,8 +706,47 @@ <h2 id="_object_prerequisites">OBJECT PREREQUISITES</h2>
710706
<h2 id="_examples">EXAMPLES</h2>
711707
<div class="sectionbody">
712708
<div class="paragraph">
713-
<p>Assume you want to transfer the history from a repository R1 on machine A
714-
to another repository R2 on machine B.
709+
<p>We&#8217;ll discuss two cases:</p>
710+
</div>
711+
<div class="olist arabic">
712+
<ol class="arabic">
713+
<li>
714+
<p>Taking a full backup of a repository</p>
715+
</li>
716+
<li>
717+
<p>Transferring the history of a repository to another machine when the
718+
two machines have no direct connection</p>
719+
</li>
720+
</ol>
721+
</div>
722+
<div class="paragraph">
723+
<p>First let&#8217;s consider a full backup of the repository. The following
724+
command will take a full backup of the repository in the sense that all
725+
refs are included in the bundle:</p>
726+
</div>
727+
<div class="listingblock">
728+
<div class="content">
729+
<pre>$ git bundle create backup.bundle --all</pre>
730+
</div>
731+
</div>
732+
<div class="paragraph">
733+
<p>But note again that this is only for the refs, i.e. you will only
734+
include refs and commits reachable from those refs. You will not
735+
include other local state, such as the contents of the index, working
736+
tree, the stash, per-repository configuration, hooks, etc.</p>
737+
</div>
738+
<div class="paragraph">
739+
<p>You can later recover that repository by using for example
740+
<a href="git-clone.html">git-clone(1)</a>:</p>
741+
</div>
742+
<div class="listingblock">
743+
<div class="content">
744+
<pre>$ git clone backup.bundle &lt;new directory&gt;</pre>
745+
</div>
746+
</div>
747+
<div class="paragraph">
748+
<p>For the next example, assume you want to transfer the history from a
749+
repository R1 on machine A to another repository R2 on machine B.
715750
For whatever reason, direct connection between A and B is not allowed,
716751
but we can move data from A to B via some mechanism (CD, email, etc.).
717752
We want to update R2 with development made on the branch master in R1.</p>
@@ -843,6 +878,29 @@ <h2 id="_examples">EXAMPLES</h2>
843878
</div>
844879
</div>
845880
<div class="sect1">
881+
<h2 id="_discussion">DISCUSSION</h2>
882+
<div class="sectionbody">
883+
<div class="paragraph">
884+
<p>A naive way to make a full backup of a repository is to use something to
885+
the effect of <code>cp</code> <code>-r</code> <em>&lt;repo&gt;</em> <em>&lt;destination&gt;</em>. This is discouraged since
886+
the repository could be written to during the copy operation. In turn
887+
some files at <em>&lt;destination&gt;</em> could be corrupted.</p>
888+
</div>
889+
<div class="paragraph">
890+
<p>This is why it is recommended to use Git tooling for making repository
891+
backups, either with this command or with e.g. <a href="git-clone.html">git-clone(1)</a>.
892+
But keep in mind that these tools will not help you backup state other
893+
than refs and commits. In other words they will not help you backup
894+
contents of the index, working tree, the stash, per-repository
895+
configuration, hooks, etc.</p>
896+
</div>
897+
<div class="paragraph">
898+
<p>See also <a href="gitfaq.html">gitfaq(7)</a>, section "TRANSFERS" for a discussion of the
899+
problems associated with file syncing across systems.</p>
900+
</div>
901+
</div>
902+
</div>
903+
<div class="sect1">
846904
<h2 id="_file_format">FILE FORMAT</h2>
847905
<div class="sectionbody">
848906
<div class="paragraph">
@@ -861,7 +919,7 @@ <h2 id="_git">GIT</h2>
861919
</div>
862920
<div id="footer">
863921
<div id="footer-text">
864-
Last updated 2023-03-19 15:16:41 -0700
922+
Last updated 2024-11-27 08:30:33 +0900
865923
</div>
866924
</div>
867925
</body>

git-bundle.txt

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ the "offline" transfer of Git objects without an active "server"
2323
sitting on the other side of the network connection.
2424

2525
They can be used to create both incremental and full backups of a
26-
repository, and to relay the state of the references in one repository
27-
to another.
26+
repository (see the "full backup" example in "EXAMPLES"), and to relay
27+
the state of the references in one repository to another (see the second
28+
example).
2829

2930
Git commands that fetch or otherwise "read" via protocols such as
3031
`ssh://` and `https://` can also operate on bundle files. It is
@@ -34,8 +35,6 @@ contained within it with linkgit:git-ls-remote[1]. There's no
3435
corresponding "write" support, i.e.a 'git push' into a bundle is not
3536
supported.
3637

37-
See the "EXAMPLES" section below for examples of how to use bundles.
38-
3938
BUNDLE FORMAT
4039
-------------
4140

@@ -132,7 +131,7 @@ SPECIFYING REFERENCES
132131
---------------------
133132

134133
Revisions must be accompanied by reference names to be packaged in a
135-
bundle.
134+
bundle. Alternatively `--all` can be used to package all refs.
136135

137136
More than one reference may be packaged, and more than one set of prerequisite objects can
138137
be specified. The objects packaged are those not contained in the
@@ -203,8 +202,6 @@ It is okay to err on the side of caution, causing the bundle file
203202
to contain objects already in the destination, as these are ignored
204203
when unpacking at the destination.
205204

206-
If you want to match `git clone --mirror`, which would include your
207-
refs such as `refs/remotes/*`, use `--all`.
208205
If you want to provide the same set of refs that a clone directly
209206
from the source repository would get, use `--branches --tags` for
210207
the `<git-rev-list-args>`.
@@ -216,8 +213,34 @@ bundle.
216213
EXAMPLES
217214
--------
218215

219-
Assume you want to transfer the history from a repository R1 on machine A
220-
to another repository R2 on machine B.
216+
We'll discuss two cases:
217+
218+
1. Taking a full backup of a repository
219+
2. Transferring the history of a repository to another machine when the
220+
two machines have no direct connection
221+
222+
First let's consider a full backup of the repository. The following
223+
command will take a full backup of the repository in the sense that all
224+
refs are included in the bundle:
225+
226+
----------------
227+
$ git bundle create backup.bundle --all
228+
----------------
229+
230+
But note again that this is only for the refs, i.e. you will only
231+
include refs and commits reachable from those refs. You will not
232+
include other local state, such as the contents of the index, working
233+
tree, the stash, per-repository configuration, hooks, etc.
234+
235+
You can later recover that repository by using for example
236+
linkgit:git-clone[1]:
237+
238+
----------------
239+
$ git clone backup.bundle <new directory>
240+
----------------
241+
242+
For the next example, assume you want to transfer the history from a
243+
repository R1 on machine A to another repository R2 on machine B.
221244
For whatever reason, direct connection between A and B is not allowed,
222245
but we can move data from A to B via some mechanism (CD, email, etc.).
223246
We want to update R2 with development made on the branch master in R1.
@@ -321,6 +344,24 @@ You can also see what references it offers:
321344
$ git ls-remote mybundle
322345
----------------
323346

347+
DISCUSSION
348+
----------
349+
350+
A naive way to make a full backup of a repository is to use something to
351+
the effect of `cp -r <repo> <destination>`. This is discouraged since
352+
the repository could be written to during the copy operation. In turn
353+
some files at `<destination>` could be corrupted.
354+
355+
This is why it is recommended to use Git tooling for making repository
356+
backups, either with this command or with e.g. linkgit:git-clone[1].
357+
But keep in mind that these tools will not help you backup state other
358+
than refs and commits. In other words they will not help you backup
359+
contents of the index, working tree, the stash, per-repository
360+
configuration, hooks, etc.
361+
362+
See also linkgit:gitfaq[7], section "TRANSFERS" for a discussion of the
363+
problems associated with file syncing across systems.
364+
324365
FILE FORMAT
325366
-----------
326367

git-index-pack.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,9 @@ <h2 id="_options">OPTIONS</h2>
627627
pack. This avoids a situation in which a repo has non-promisor objects that are
628628
accessible through promisor objects.</p>
629629
</div>
630+
<div class="paragraph">
631+
<p>Requires &lt;pack-file&gt; to not be specified.</p>
632+
</div>
630633
</dd>
631634
</dl>
632635
</div>
@@ -656,7 +659,7 @@ <h2 id="_git">GIT</h2>
656659
</div>
657660
<div id="footer">
658661
<div id="footer-text">
659-
Last updated 2024-11-20 15:41:07 +0900
662+
Last updated 2024-11-27 08:30:33 +0900
660663
</div>
661664
</div>
662665
</body>

git-index-pack.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,8 @@ Also, if there are objects in the given pack that references non-promisor
144144
objects (in the repo), repacks those non-promisor objects into a promisor
145145
pack. This avoids a situation in which a repo has non-promisor objects that are
146146
accessible through promisor objects.
147+
+
148+
Requires <pack-file> to not be specified.
147149

148150
NOTES
149151
-----

git-remote-helpers.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@
442442
<div id="header">
443443
<h1>git-remote-helpers</h1>
444444
<div class="details">
445-
<span id="revdate">2024-11-25</span>
445+
<span id="revdate">2024-11-27</span>
446446
</div>
447447
</div>
448448
<div id="content">

gitglossary.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1313,6 +1313,12 @@ <h2 id="_description">DESCRIPTION</h2>
13131313
that each contain very well defined concepts or small incremental yet
13141314
related changes.</p>
13151315
</dd>
1316+
<dt class="hdlist1"><a id="def_trailer"></a>trailer</dt>
1317+
<dd>
1318+
<p>Key-value metadata. Trailers are optionally found at the end of
1319+
a commit message. Might be called "footers" or "tags" in other
1320+
communities. See <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>.</p>
1321+
</dd>
13161322
<dt class="hdlist1"><a id="def_tree"></a>tree</dt>
13171323
<dd>
13181324
<p>Either a <a href="#def_working_tree">working tree</a>, or a <a href="#def_tree_object">tree
@@ -1412,7 +1418,7 @@ <h2 id="_git">GIT</h2>
14121418
</div>
14131419
<div id="footer">
14141420
<div id="footer-text">
1415-
Last updated 2020-03-10 15:02:33 -0700
1421+
Last updated 2020-03-11 07:02:33 +0900
14161422
</div>
14171423
</div>
14181424
</body>

0 commit comments

Comments
 (0)