diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 14:47:53 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 14:47:53 +0000 |
commit | c8bae7493d2f2910b57f13ded012e86bdcfb0532 (patch) | |
tree | 24e09d9f84dec336720cf393e156089ca2835791 /Documentation/git-prune.txt | |
parent | Initial commit. (diff) | |
download | git-upstream.tar.xz git-upstream.zip |
Adding upstream version 1:2.39.2.upstream/1%2.39.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/git-prune.txt')
-rw-r--r-- | Documentation/git-prune.txt | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt new file mode 100644 index 0000000..03552dd --- /dev/null +++ b/Documentation/git-prune.txt @@ -0,0 +1,89 @@ +git-prune(1) +============ + +NAME +---- +git-prune - Prune all unreachable objects from the object database + + +SYNOPSIS +-------- +[verse] +'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<head>...] + +DESCRIPTION +----------- + +NOTE: In most cases, users should run 'git gc', which calls +'git prune'. See the section "NOTES", below. + +This runs 'git fsck --unreachable' using all the refs +available in `refs/`, optionally with additional set of +objects specified on the command line, and prunes all unpacked +objects unreachable from any of these head objects from the object database. +In addition, it +prunes the unpacked objects that are also found in packs by +running 'git prune-packed'. +It also removes entries from .git/shallow that are not reachable by +any ref. + +Note that unreachable, packed objects will remain. If this is +not desired, see linkgit:git-repack[1]. + +OPTIONS +------- + +-n:: +--dry-run:: + Do not remove anything; just report what it would + remove. + +-v:: +--verbose:: + Report all removed objects. + +--progress:: + Show progress. + +--expire <time>:: + Only expire loose objects older than <time>. + +\--:: + Do not interpret any more arguments as options. + +<head>...:: + In addition to objects + reachable from any of our references, keep objects + reachable from listed <head>s. + +EXAMPLES +-------- + +To prune objects not used by your repository or another that +borrows from your repository via its +`.git/objects/info/alternates`: + +------------ +$ 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 'git gc', 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] + +GIT +--- +Part of the linkgit:git[1] suite |