undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
85b460305c
git-commit-vandalism/Documentation/git-prune.txt

90 lines
1.9 KiB
Plaintext
Raw Normal View History

Big tool rename. As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-08 02:26:23 +02:00
git-prune(1)
============
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
NAME
----
Make command description imperative statement, not third-person present. In several of the text messages, the tense of the verb is inconsistent. For example, "Add" vs "Creates". It is customary to use imperative for command description. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-06-09 17:44:12 +02:00
git-prune - Prune all unreachable objects from the object database
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
SYNOPSIS
--------
Documentation: use [verse] for SYNOPSIS sections The SYNOPSIS sections of most commands that span several lines already use [verse] to retain line breaks. Most commands that don't span several lines seem not to use [verse]. In the HTML output, [verse] does not only preserve line breaks, but also makes the section indented, which causes a slight inconsistency between commands that use [verse] and those that don't. Use [verse] in all SYNOPSIS sections for consistency. Also remove the blank lines from git-fetch.txt and git-rebase.txt to align with the other man pages. In the case of git-rebase.txt, which already uses [verse], the blank line makes the [verse] not apply to the last line, so removing the blank line also makes the formatting within the document more consistent. While at it, add single quotes to 'git cvsimport' for consistency with other commands. Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-07-02 04:38:26 +02:00
[verse]
prune: add "--progress" to man page and usage msg Add mention of git prune's "--progress" option to the SYNOPSIS and DESCRIPTION sections of the man page, and to the usage message of "git prune" itself. While we're here, move the explanation of "--" toward the end of the DESCRIPTION section, where it belongs. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-11-21 16:51:52 +01:00
'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
DESCRIPTION
-----------
Accumulated documentation updates. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 02:21:06 +02:00
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
NOTE: In most cases, users should run 'git gc', which calls
'git prune'. See the section "NOTES", below.
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>
2008-04-29 22:45:14 +02:00
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
This runs 'git fsck --unreachable' using all the refs
docs: don't talk about $GIT_DIR/refs/ everywhere It is misleading to say that we pull refs from $GIT_DIR/refs/*, because we may also consult the packed refs mechanism. These days we tend to treat the "refs hierarchy" as more of an abstract namespace that happens to be represented as $GIT_DIR/refs. At best, this is a minor inaccuracy, but at worst it can confuse users who then look in $GIT_DIR/refs and find that it is missing some of the refs they expected to see. This patch drops most uses of "$GIT_DIR/refs/*", changing them into just "refs/*", under the assumption that users can handle the concept of an abstract refs namespace. There are a few things to note: - most cases just dropped the $GIT_DIR/ portion. But for cases where that left _just_ the word "refs", I changed it to "refs/" to help indicate that it was a hierarchy. I didn't do the same for longer paths (e.g., "refs/heads" remained, instead of becoming "refs/heads/"). - in some cases, no change was made, as the text was explicitly about unpacked refs (e.g., the discussion in git-pack-refs). - In some cases it made sense instead to note the existence of packed refs (e.g., in check-ref-format and rev-parse). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-18 02:16:20 +01:00
available in `refs/`, optionally with additional set of
Documentation/git-prune.txt: document unpacked logic Clarifies the git-prune man page, documenting that it only prunes unpacked objects. Signed-off-by: Chris Frey <cdfrey@foursquare.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-05-15 01:22:18 +02:00
objects specified on the command line, and prunes all unpacked
git-prune: never lose objects reachable from our refs. Explicit <head> arguments to git-prune replaces, instead of extends, the list of heads used for reachability analysis by fsck-objects. By giving a subset of heads by mistake, objects reachable only from other heads can be removed, resulting in a corrupted repository. This commit stops replacing the list of heads, and makes the command line arguments to add to them instead for safety. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 08:18:41 +01:00
objects unreachable from any of these head objects from the object database.
In addition, it
Accumulated documentation updates. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 02:21:06 +02:00
prunes the unpacked objects that are also found in packs by
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
running 'git prune-packed'.
prune: clean .git/shallow after pruning objects This patch teaches "prune" to remove shallow roots that are no longer reachable from any refs (e.g. when the relevant refs are removed). Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-12-05 14:02:54 +01:00
It also removes entries from .git/shallow that are not reachable by
any ref.
Accumulated documentation updates. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 02:21:06 +02:00
Documentation/git-prune.txt: document unpacked logic Clarifies the git-prune man page, documenting that it only prunes unpacked objects. Signed-off-by: Chris Frey <cdfrey@foursquare.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-05-15 01:22:18 +02:00
Note that unreachable, packed objects will remain. If this is
not desired, see linkgit:git-repack[1].
Accumulated documentation updates. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 02:21:06 +02:00
OPTIONS
-------
-n::
prune: allow --dry-run for -n and --verbose for -v For consistency with other git commands, let git prune accept the long options --dry-run and --verbose for the respective short ones -n and -v. Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-08-06 22:28:05 +02:00
--dry-run::
Accumulated documentation updates. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 02:21:06 +02:00
Do not remove anything; just report what it would
remove.
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
make prune report removed objects on -v This adds an option "-v" which makes "git prune" more verbose: It outputs all removed objects while removing them. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2008-09-29 18:49:52 +02:00
-v::
prune: allow --dry-run for -n and --verbose for -v For consistency with other git commands, let git prune accept the long options --dry-run and --verbose for the respective short ones -n and -v. Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-08-06 22:28:05 +02:00
--verbose::
make prune report removed objects on -v This adds an option "-v" which makes "git prune" more verbose: It outputs all removed objects while removing them. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2008-09-29 18:49:52 +02:00
Report all removed objects.
prune: add "--progress" to man page and usage msg Add mention of git prune's "--progress" option to the SYNOPSIS and DESCRIPTION sections of the man page, and to the usage message of "git prune" itself. While we're here, move the explanation of "--" toward the end of the DESCRIPTION section, where it belongs. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-11-21 16:51:52 +01:00
--progress::
Show progress.
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
Docs: Use "-l::\n--long\n" format in OPTIONS sections The OPTIONS section of a documentation file contains a list of the options a git command accepts. Currently there are several variants to describe the case that different options (almost) do the same in the OPTIONS section. Some are: -f, --foo:: -f|--foo:: -f | --foo:: But AsciiDoc has the special form: -f:: --foo:: This patch applies this form to the documentation of the whole git suite, and removes useless em-dash prevention, so \--foo becomes --foo. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-08 03:36:09 +02:00
--expire <time>::
Add "--expire <time>" option to 'git prune' Earlier, 'git prune' would prune all loose unreachable objects. This could be quite dangerous, as the objects could be used in an ongoing operation. This patch adds a mode to expire only loose, unreachable objects which are older than a certain time. For example, by git prune --expire 14.days you can prune only those objects which are loose, unreachable and older than 14 days (and thus probably outdated). The implementation uses st.st_mtime rather than st.st_ctime, because it can be tested better, using 'touch -d <time>' (and omitting the test when the platform does not support that command line switch). Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-29 21:59:55 +01:00
Only expire loose objects older than <time>.
prune: add "--progress" to man page and usage msg Add mention of git prune's "--progress" option to the SYNOPSIS and DESCRIPTION sections of the man page, and to the usage message of "git prune" itself. While we're here, move the explanation of "--" toward the end of the DESCRIPTION section, where it belongs. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-11-21 16:51:52 +01:00
\--::
Do not interpret any more arguments as options.
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
<head>...::
git-prune: never lose objects reachable from our refs. Explicit <head> arguments to git-prune replaces, instead of extends, the list of heads used for reachability analysis by fsck-objects. By giving a subset of heads by mistake, objects reachable only from other heads can be removed, resulting in a corrupted repository. This commit stops replacing the list of heads, and makes the command line arguments to add to them instead for safety. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 08:18:41 +01:00
In addition to objects
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
reachable from any of our references, keep objects
git-prune: never lose objects reachable from our refs. Explicit <head> arguments to git-prune replaces, instead of extends, the list of heads used for reachability analysis by fsck-objects. By giving a subset of heads by mistake, objects reachable only from other heads can be removed, resulting in a corrupted repository. This commit stops replacing the list of heads, and makes the command line arguments to add to them instead for safety. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 08:18:41 +01:00
reachable from listed <head>s.
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
EXAMPLE
-------
Documentation: fix misuses of "nor" Signed-off-by: Justin Lebar <jlebar@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-04-01 00:11:44 +02:00
To prune objects not used by your repository or another that
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
borrows from your repository via its
`.git/objects/info/alternates`:
------------
Documentation: fix git-prune example usage Signed-off-by: Jonathon Mah <me@JonathonMah.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-18 18:53:55 +02:00
$ git prune $(cd ../another && git rev-parse --all)
Documentation: git-prune Not replacing but always including our own refs may be more desirable (and unarguably much safer), but at the same time I have a suspicion that that might be forbidding a useful usage I haven't thought of, so... Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-09 01:30:24 +01:00
------------
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
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>
2008-04-29 22:45:14 +02:00
Notes
-----
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
In most cases, users will not need to call 'git prune' directly, but
should instead call 'git gc', which handles pruning along with
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>
2008-04-29 22:45:14 +02:00
many other housekeeping tasks.
For a description of which objects are considered for pruning, see
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
'git fsck''s --unreachable option.
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>
2008-04-29 22:45:14 +02:00
Manual subsection to refer to other pages is SEE ALSO Consistently say so in all caps as it is customary to do so. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-05-29 01:55:27 +02:00
SEE ALSO
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>
2008-04-29 22:45:14 +02:00
--------
linkgit:git-fsck[1],
linkgit:git-gc[1],
linkgit:git-reflog[1]
[PATCH 1/4] split core-git.txt and update Split the core-git.txt file Formatting fix to the diff-format.txt Signed-off-by: David Greaves <david@dgreaves.com>
2005-05-10 23:32:30 +02:00
GIT
---
documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-06 09:07:32 +02:00
Part of the linkgit:git[1] suite
Reference in New Issue Copy Permalink