doc/git-gc: add a note about what is collected
It seems to be a FAQ that people try running git-gc, and then get puzzled about why the size of their .git directory didn't change. This note mentions the reasons why things might unexpectedly get kept. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Apr 23, 2008 at 21:28 UTC
3ffb58be0a779b47e1e4d3ea584ba301461a3a77
1 file changed
+15
Documentation/git-gc.txt
+15
@@ -104,6 +104,21 @@ The optional configuration variable 'gc.pruneExpire' controls how old
104
the unreferenced loose objects have to be before they are pruned. The
105
default is "2 weeks ago".
106
107
+
108
+Notes
109
+-----
110
+
111
+git-gc tries very hard to be safe about the garbage it collects. In
112
+particular, it will keep not only objects referenced by your current set
113
+of branches and tags, but also objects referenced by the index, remote
114
+tracking branches, refs saved by linkgit:git-filter-branch[1] in
115
+refs/original/, or reflogs (which may references commits in branches
116
+that were later amended or rewound).
117
+
118
+If you are expecting some objects to be collected and they aren't, check
119
+all of those locations and decide whether it makes sense in your case to
120
+remove those references.
121
+
122
See Also
123
--------
124
linkgit:git-prune[1]