Skip to content

Commit

Permalink
user-manual: Rewrite git-gc section for automatic packing
Browse files Browse the repository at this point in the history
This should have happened back in 2007, when `git gc` learned about
auto (e9831e8, git-gc --auto: add documentation, 2007-09-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
W. Trevor King authored and Junio C Hamano committed Feb 11, 2013
1 parent da2c7b3 commit 901fd18
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions Documentation/user-manual.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1561,18 +1561,12 @@ $ git stash pop
Ensuring good performance
-------------------------

On large repositories, git depends on compression to keep the history
information from taking up too much space on disk or in memory.

This compression is not performed automatically. Therefore you
should occasionally run linkgit:git-gc[1]:

-------------------------------------------------
$ git gc
-------------------------------------------------

to recompress the archive. This can be very time-consuming, so
you may prefer to run `git gc` when you are not doing other work.
On large repositories, Git depends on compression to keep the history
information from taking up too much space on disk or in memory. Some
git commands may automatically run linkgit:git-gc[1], so you don't
have to worry about running it manually. However, compressing a large
repository may take a while, so you may want to call `gc` explicitly
to avoid automatic compression kicking in when it is not convenient.


[[ensuring-reliability]]
Expand Down

0 comments on commit 901fd18

Please sign in to comment.