]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation/git-bundle.txt: mention full backup example
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Sat, 16 Nov 2024 14:54:51 +0000 (15:54 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2024 00:56:25 +0000 (09:56 +0900)
commitdf0cf6faad08fb5a2467c694e1fecec58a5d6df5
tree32589a12eb4eed44e2b322e3023d66da90316514
parent34b6ce9b30747131b6e781ff718a45328aa887d0
Documentation/git-bundle.txt: mention full backup example

Provide an example about how to make a “full backup” with caveats about
what that means in this case.

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.
Let’s drop this mention of `--all` later in the doc and frontload it.

† 1: E.g.:

    • https://stackoverflow.com/questions/5578270/fully-backup-a-git-repo
    • https://stackoverflow.com/questions/11792671/how-to-git-bundle-a-complete-repo

Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-bundle.txt