summaryrefslogtreecommitdiff
path: root/Documentation/git-gc.txt
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@uchicago.edu>2008-06-30 18:56:34 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-07-02 00:20:16 (GMT)
commit483bc4f045881b998512ae814d6cf44d0c0cb493 (patch)
tree1812b25a8f08841bd4cfb6566636ce6fb5b8eac3 /Documentation/git-gc.txt
parentb1889c36d85514e5e70462294c561a02c2edfe2b (diff)
downloadgit-483bc4f045881b998512ae814d6cf44d0c0cb493.zip
git-483bc4f045881b998512ae814d6cf44d0c0cb493.tar.gz
git-483bc4f045881b998512ae814d6cf44d0c0cb493.tar.bz2
Documentation formatting and cleanup
Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-gc.txt')
-rw-r--r--Documentation/git-gc.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 587ce14..0cce389 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -15,7 +15,7 @@ DESCRIPTION
Runs a number of housekeeping tasks within the current repository,
such as compressing file revisions (to reduce disk space and increase
performance) and removing unreachable objects which may have been
-created from prior invocations of linkgit:git-add[1].
+created from prior invocations of `git-add`.
Users are encouraged to run this task on a regular basis within
each repository to maintain good disk space utilization and good
@@ -33,9 +33,9 @@ OPTIONS
-------
--aggressive::
- Usually 'git-gc' runs very quickly while providing good disk
+ Usually `git-gc` runs very quickly while providing good disk
space utilization and performance. This option will cause
- git-gc to more aggressively optimize the repository at the expense
+ `git-gc` to more aggressively optimize the repository at the expense
of taking much more time. The effects of this optimization are
persistent, so this option only needs to be used occasionally; every
few hundred changesets or so.
@@ -108,10 +108,10 @@ default is "2 weeks ago".
Notes
-----
-git-gc tries very hard to be safe about the garbage it collects. In
+`git-gc` tries very hard to be safe about the garbage it collects. In
particular, it will keep not only objects referenced by your current set
of branches and tags, but also objects referenced by the index, remote
-tracking branches, refs saved by linkgit:git-filter-branch[1] in
+tracking branches, refs saved by `git-filter-branch` in
refs/original/, or reflogs (which may references commits in branches
that were later amended or rewound).