git-clone -s: document problems with git gc --prune
There is a scenario when using git clone -s and git gc --prune togother is dangerous. Document this. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Miklos Vajna committed
Jan 22, 2008 at 23:12 UTC
28678b4f2f2e449986de4a6fc2dc93b32299ca74
1 file changed
+8
Documentation/git-clone.txt
+8
@@ -62,6 +62,14 @@ OPTIONS
62
.git/objects/info/alternates to share the objects
63
with the source repository. The resulting repository
64
starts out without any object of its own.
65
+ *NOTE*: this is a possibly dangerous operation; do *not* use
66
+ it unless you understand what it does. If you clone your
67
+ repository using this option, then delete branches in the
68
+ source repository and then run linkgit:git-gc[1] using the
69
+ '--prune' option in the source repository, it may remove
70
+ objects which are referenced by the cloned repository.
71
+
72
+
73
74
--reference <repository>::
75
If the reference repository is on the local machine