Skip to content

Commit 901fd18

Browse files
wkinggitster
authored andcommitted
user-manual: Rewrite git-gc section for automatic packing
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent da2c7b3 commit 901fd18

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

Documentation/user-manual.txt

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1561,18 +1561,12 @@ $ git stash pop
15611561
Ensuring good performance
15621562
-------------------------
15631563

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

15771571

15781572
[[ensuring-reliability]]

0 commit comments

Comments
 (0)