[PATCH 2/4] Documentation/git-bundle.txt: mention full backup example
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- Oct 20, 2024, 19:15 UTC
- Message-ID
- <f7d9aa89c953ca7d15b5047487b4347ef62e77a9.1729451376.git.code@khaugsbakk.name>
- In-Reply-To
- <cover.1729451376.git.code@khaugsbakk.name>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Tell the user how to make a full backup of the repository right at the start of the doc.
This is a requested use-case.[1] But the doc is a bit unassuming about it:
“ If you want to match `git clone --mirror`, which would include your
refs such as `refs/remotes/*`, use `--all`.The user cannot be expected to formulate “I want a full backup” as “I want to match `git clone --mirror`” for a bundle file or something.
🔗 1: https://stackoverflow.com/a/5578292/1725151
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- Documentation/git-bundle.txt | 3 +++ 1 file changed, 3 insertions(+)
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index 7579dd309ac..bf0d448a736 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -26,6 +26,9 @@ 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. +You can use `git bundle create <file> --all` to create a full backup of +your repository. + Git commands that fetch or otherwise "read" via protocols such as `ssh://` and `https://` can also operate on bundle files. It is possible linkgit:git-clone[1] a new repository from a bundle, to use
-- 2.46.1.641.g54e7913fcb6