git-clone.txt: Adjust note to --shared for new pruning behavior of git-gc
Since git-gc now always calls prune, even with --auto, unreferenced objects may be removed by more operations than just git-gc. This is important for clones created using --shared or --reference. Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil> Signed-off-by: Dmitry Potapov <dpotapov@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Brandon Casey committed
Apr 3, 2008 at 13:26 UTC
2498a1ad0b0fc06f1fd40074b9bb55eb3d7ae094
1 file changed
+9
-4
Documentation/git-clone.txt
+9
-4
@@ -65,10 +65,13 @@ OPTIONS
65
+
66
*NOTE*: this is a possibly dangerous operation; do *not* use
67
it unless you understand what it does. If you clone your
68
-repository using this option, then delete branches in the
69
-source repository and then run linkgit:git-gc[1] using the
70
-'--prune' option in the source repository, it may remove
71
-objects which are referenced by the cloned repository.
68
+repository using this option and then delete branches (or use any
69
+other git command that makes any existing commit unreferenced) in the
70
+source repository, some objects may become unreferenced (or dangling).
71
+These objects may be removed by normal git operations (such as git-commit[1])
72
+which automatically call git-gc[1]. If these objects are removed and
73
+were referenced by the cloned repository, then the cloned repository
74
+will become corrupt.
75
76
77
@@ -79,6 +82,8 @@ objects which are referenced by the cloned repository.
82
an already existing repository as an alternate will
83
require fewer objects to be copied from the repository
84
being cloned, reducing network and local storage costs.
85
++
86
+*NOTE*: see NOTE to --shared option.
87
88
--quiet::
89
-q::