git/Documentation/git-prune.txt
Nguyễn Thái Ngọc Duy 76a8788c14 doc: keep first level section header in upper case
When formatted as a man page, 1st section header is always in upper
case even if we write it otherwise. Make all 1st section headers
uppercase to keep it close to the final output.

This does affect html since case is kept there, but I still think it's
a good idea to maintain a consistent style for 1st section headers.

Some sections perhaps should become second sections instead, where
case is kept, and for better organization. I will update if anyone has
suggestions about this.

While at there I also make some header more consistent (e.g. examples
vs example) and fix a couple minor things here and there.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-05-02 17:03:33 +09:00

90 lines
1.9 KiB
Plaintext

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