summaryrefslogtreecommitdiff
path: root/Documentation/git-prune.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2008-04-29 20:45:14 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-04-30 06:11:57 (GMT)
commit8d308b35401b6abebb65aa97a322526ae11d7220 (patch)
tree0ac12a1d8ac7b0847fffeb6c0d9f2e7a377e3cff /Documentation/git-prune.txt
parent302cc11a32732a0a3f0a7875b1857098e1964929 (diff)
downloadgit-8d308b35401b6abebb65aa97a322526ae11d7220.zip
git-8d308b35401b6abebb65aa97a322526ae11d7220.tar.gz
git-8d308b35401b6abebb65aa97a322526ae11d7220.tar.bz2
Documentation: point git-prune users to git-gc
Most users should be using git-gc instead of directly calling prune. For those who really do want more information on pruning, let's point them at git-fsck, which goes into slightly more detail on reachability. And since we're pointing users there, let's make sure reflogs are mentioned in git-fsck(1). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-prune.txt')
-rw-r--r--Documentation/git-prune.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index f151cff..f92bb8c 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -13,6 +13,9 @@ SYNOPSIS
DESCRIPTION
-----------
+NOTE: In most cases, users should run linkgit:git-gc[1], which calls
+git-prune. See the section "NOTES", below.
+
This runs `git-fsck --unreachable` using all the refs
available in `$GIT_DIR/refs`, optionally with additional set of
objects specified on the command line, and prunes all
@@ -50,6 +53,23 @@ borrows from your repository via its
$ git prune $(cd ../another && $(git-rev-parse --all))
------------
+Notes
+-----
+
+In most cases, users will not need to call git-prune directly, but
+should instead call linkgit:git-gc[1], which handles pruning along with
+many other housekeeping tasks.
+
+For a description of which objects are considered for pruning, see
+git-fsck's --unreachable option.
+
+See Also
+--------
+
+linkgit:git-fsck[1],
+linkgit:git-gc[1],
+linkgit:git-reflog[1]
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org>