Documentation/git-bundle.txt: discuss naïve backups

It might be naïve to think that those who need this education would end
up here in the first place.  But I think it’s good to mention this
high-level concept here on a command which provides a backup strategy.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Kristoffer Haugsbakk 2024-11-16 15:54:54 +01:00 committed by Junio C Hamano
parent c43a67f83d
commit 820fd1a569
1 changed files with 18 additions and 0 deletions

View File

@ -344,6 +344,24 @@ You can also see what references it offers:
$ git ls-remote mybundle $ 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 FILE FORMAT
----------- -----------