Skip to content

Commit

Permalink
Autogenerated HTML docs for v2.47.0-365-gcc01ba
Browse files Browse the repository at this point in the history
  • Loading branch information
gitster committed Nov 26, 2024
1 parent f3e22b3 commit 8a42471
Show file tree
Hide file tree
Showing 52 changed files with 222 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-11-25</span>
<span id="revdate">2024-11-27</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-11-25</span>
<span id="revdate">2024-11-27</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-11-25</span>
<span id="revdate">2024-11-27</span>
</div>
</div>
<div id="content">
Expand Down
21 changes: 21 additions & 0 deletions RelNotes/2.48.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ UI, Workflows & Features
* Teach 'git notes add' and 'git notes append' a new '-e' flag,
instructing them to open the note in $GIT_EDITOR before saving.

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


Performance, Internal Implementation, Development Support etc.
--------------------------------------------------------------
Expand Down Expand Up @@ -82,6 +85,15 @@ Performance, Internal Implementation, Development Support etc.

* Renaming a handful of variables and structure fields.

* Fix for clar unit tests to support CMake build.

* C23 compatibility updates.

* GCC 15 compatibility updates.

* We now ensure "index-pack" is used with the "--promisor" option
only during a "git fetch".


Fixes since v2.47
-----------------
Expand Down Expand Up @@ -159,6 +171,14 @@ Fixes since v2.47
of object.
(merge e199290592 tb/multi-pack-reuse-dupfix later to maint).

* "git fast-import" can be tricked into a replace ref that maps an
object to itself, which is a useless thing to do.
(merge 5e904f1a4a en/fast-import-avoid-self-replace later to maint).

* The ref-transaction hook triggered for reflog updates, which has
been corrected.
(merge b886db48c6 kn/ref-transaction-hook-with-reflog later to maint).

* Other code cleanup, docfix, build fix, etc.
(merge 1164e270b5 jk/output-prefix-cleanup later to maint).
(merge f36b8cbaef jh/config-unset-doc-fix later to maint).
Expand All @@ -172,3 +192,4 @@ Fixes since v2.47
(merge f1ed39987b xx/protocol-v2-doc-markup-fix later to maint).
(merge 41869f7447 ak/typofixes later to maint).
(merge dcd590a39d bf/t-readme-mention-reftable later to maint).
(merge 68e3c69efa kh/trailer-in-glossary 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-11-25</span>
<span id="revdate">2024-11-27</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-11-25</span>
<span id="revdate">2024-11-27</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-11-25</span>
<span id="revdate">2024-11-27</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-11-25</span>
<span id="revdate">2024-11-27</span>
</div>
</div>
<div id="content">
Expand Down
82 changes: 70 additions & 12 deletions git-bundle.html
Original file line number Diff line number Diff line change
Expand Up @@ -469,8 +469,9 @@ <h2 id="_description">DESCRIPTION</h2>
</div>
<div class="paragraph">
<p>They can be used to create both incremental and full backups of a
repository, and to relay the state of the references in one repository
to another.</p>
repository (see the "full backup" example in "EXAMPLES"), and to relay
the state of the references in one repository to another (see the second
example).</p>
</div>
<div class="paragraph">
<p>Git commands that fetch or otherwise "read" via protocols such as
Expand All @@ -481,9 +482,6 @@ <h2 id="_description">DESCRIPTION</h2>
corresponding "write" support, i.e.a <em>git push</em> into a bundle is not
supported.</p>
</div>
<div class="paragraph">
<p>See the "EXAMPLES" section below for examples of how to use bundles.</p>
</div>
</div>
</div>
<div class="sect1">
Expand Down Expand Up @@ -604,7 +602,7 @@ <h2 id="_specifying_references">SPECIFYING REFERENCES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Revisions must be accompanied by reference names to be packaged in a
bundle.</p>
bundle. Alternatively <code>--all</code> can be used to package all refs.</p>
</div>
<div class="paragraph">
<p>More than one reference may be packaged, and more than one set of prerequisite objects can
Expand Down Expand Up @@ -693,9 +691,7 @@ <h2 id="_object_prerequisites">OBJECT PREREQUISITES</h2>
when unpacking at the destination.</p>
</div>
<div class="paragraph">
<p>If you want to match <code>git</code> <code>clone</code> <code>--mirror</code>, which would include your
refs such as <code>refs/remotes/</code>*, use <code>--all</code>.
If you want to provide the same set of refs that a clone directly
<p>If you want to provide the same set of refs that a clone directly
from the source repository would get, use <code>--branches</code> <code>--tags</code> for
the <em>&lt;git-rev-list-args&gt;</em>.</p>
</div>
Expand All @@ -710,8 +706,47 @@ <h2 id="_object_prerequisites">OBJECT PREREQUISITES</h2>
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Assume you want to transfer the history from a repository R1 on machine A
to another repository R2 on machine B.
<p>We&#8217;ll discuss two cases:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Taking a full backup of a repository</p>
</li>
<li>
<p>Transferring the history of a repository to another machine when the
two machines have no direct connection</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>First let&#8217;s consider a full backup of the repository. The following
command will take a full backup of the repository in the sense that all
refs are included in the bundle:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>$ git bundle create backup.bundle --all</pre>
</div>
</div>
<div class="paragraph">
<p>But note again that this is only for the refs, i.e. you will only
include refs and commits reachable from those refs. You will not
include other local state, such as the contents of the index, working
tree, the stash, per-repository configuration, hooks, etc.</p>
</div>
<div class="paragraph">
<p>You can later recover that repository by using for example
<a href="git-clone.html">git-clone(1)</a>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>$ git clone backup.bundle &lt;new directory&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>For the next example, assume you want to transfer the history from a
repository R1 on machine A to another repository R2 on machine B.
For whatever reason, direct connection between A and B is not allowed,
but we can move data from A to B via some mechanism (CD, email, etc.).
We want to update R2 with development made on the branch master in R1.</p>
Expand Down Expand Up @@ -843,6 +878,29 @@ <h2 id="_examples">EXAMPLES</h2>
</div>
</div>
<div class="sect1">
<h2 id="_discussion">DISCUSSION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A naive way to make a full backup of a repository is to use something to
the effect of <code>cp</code> <code>-r</code> <em>&lt;repo&gt;</em> <em>&lt;destination&gt;</em>. This is discouraged since
the repository could be written to during the copy operation. In turn
some files at <em>&lt;destination&gt;</em> could be corrupted.</p>
</div>
<div class="paragraph">
<p>This is why it is recommended to use Git tooling for making repository
backups, either with this command or with e.g. <a href="git-clone.html">git-clone(1)</a>.
But keep in mind that these tools will not help you backup state other
than refs and commits. In other words they will not help you backup
contents of the index, working tree, the stash, per-repository
configuration, hooks, etc.</p>
</div>
<div class="paragraph">
<p>See also <a href="gitfaq.html">gitfaq(7)</a>, section "TRANSFERS" for a discussion of the
problems associated with file syncing across systems.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_file_format">FILE FORMAT</h2>
<div class="sectionbody">
<div class="paragraph">
Expand All @@ -861,7 +919,7 @@ <h2 id="_git">GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-03-19 15:16:41 -0700
Last updated 2024-11-27 08:30:33 +0900
</div>
</div>
</body>
Expand Down
59 changes: 50 additions & 9 deletions git-bundle.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ the "offline" transfer of Git objects without an active "server"
sitting on the other side of the network connection.

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

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

See the "EXAMPLES" section below for examples of how to use bundles.

BUNDLE FORMAT
-------------

Expand Down Expand Up @@ -132,7 +131,7 @@ SPECIFYING REFERENCES
---------------------

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

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

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

Assume you want to transfer the history from a repository R1 on machine A
to another repository R2 on machine B.
We'll discuss two cases:

1. Taking a full backup of a repository
2. Transferring the history of a repository to another machine when the
two machines have no direct connection

First let's consider a full backup of the repository. The following
command will take a full backup of the repository in the sense that all
refs are included in the bundle:

----------------
$ git bundle create backup.bundle --all
----------------

But note again that this is only for the refs, i.e. you will only
include refs and commits reachable from those refs. You will not
include other local state, such as the contents of the index, working
tree, the stash, per-repository configuration, hooks, etc.

You can later recover that repository by using for example
linkgit:git-clone[1]:

----------------
$ git clone backup.bundle <new directory>
----------------

For the next example, assume you want to transfer the history from a
repository R1 on machine A to another repository R2 on machine B.
For whatever reason, direct connection between A and B is not allowed,
but we can move data from A to B via some mechanism (CD, email, etc.).
We want to update R2 with development made on the branch master in R1.
Expand Down Expand Up @@ -321,6 +344,24 @@ You can also see what references it offers:
$ git ls-remote mybundle
----------------

DISCUSSION
----------

A naive way to make a full backup of a repository is to use something to
the effect of `cp -r <repo> <destination>`. This is discouraged since
the repository could be written to during the copy operation. In turn
some files at `<destination>` could be corrupted.

This is why it is recommended to use Git tooling for making repository
backups, either with this command or with e.g. linkgit:git-clone[1].
But keep in mind that these tools will not help you backup state other
than refs and commits. In other words they will not help you backup
contents of the index, working tree, the stash, per-repository
configuration, hooks, etc.

See also linkgit:gitfaq[7], section "TRANSFERS" for a discussion of the
problems associated with file syncing across systems.

FILE FORMAT
-----------

Expand Down
5 changes: 4 additions & 1 deletion git-index-pack.html
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,9 @@ <h2 id="_options">OPTIONS</h2>
pack. This avoids a situation in which a repo has non-promisor objects that are
accessible through promisor objects.</p>
</div>
<div class="paragraph">
<p>Requires &lt;pack-file&gt; to not be specified.</p>
</div>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -656,7 +659,7 @@ <h2 id="_git">GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-11-20 15:41:07 +0900
Last updated 2024-11-27 08:30:33 +0900
</div>
</div>
</body>
Expand Down
2 changes: 2 additions & 0 deletions git-index-pack.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ Also, if there are objects in the given pack that references non-promisor
objects (in the repo), repacks those non-promisor objects into a promisor
pack. This avoids a situation in which a repo has non-promisor objects that are
accessible through promisor objects.
+
Requires <pack-file> to not be specified.

NOTES
-----
Expand Down
2 changes: 1 addition & 1 deletion git-remote-helpers.html
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@
<div id="header">
<h1>git-remote-helpers</h1>
<div class="details">
<span id="revdate">2024-11-25</span>
<span id="revdate">2024-11-27</span>
</div>
</div>
<div id="content">
Expand Down
8 changes: 7 additions & 1 deletion gitglossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -1313,6 +1313,12 @@ <h2 id="_description">DESCRIPTION</h2>
that each contain very well defined concepts or small incremental yet
related changes.</p>
</dd>
<dt class="hdlist1"><a id="def_trailer"></a>trailer</dt>
<dd>
<p>Key-value metadata. Trailers are optionally found at the end of
a commit message. Might be called "footers" or "tags" in other
communities. See <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>.</p>
</dd>
<dt class="hdlist1"><a id="def_tree"></a>tree</dt>
<dd>
<p>Either a <a href="#def_working_tree">working tree</a>, or a <a href="#def_tree_object">tree
Expand Down Expand Up @@ -1412,7 +1418,7 @@ <h2 id="_git">GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-03-10 15:02:33 -0700
Last updated 2020-03-11 07:02:33 +0900
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 8a42471

Please sign in to comment.