[PATCH] user-manual: Rewrite git-gc section for automatic packing
- From
W. Trevor King <wking@tremily.us>
- Date
- Feb 8, 2013, 16:43 UTC
- Message-ID
- <7ac63ea832711ad4bee636163e277a408cbddda4.1360341577.git.wking@tremily.us>
From: "W. Trevor King" <wking@tremily.us>
This should have happened back in 2007, when `git gc` learned about auto:
commit e9831e83e063844b90cf9e525d0003715dd8b395 Author: Junio C Hamano <gitster@pobox.com> Date: Mon Sep 17 00:39:52 2007 -0700
git-gc --auto: add documentation.
Signed-off-by: W. Trevor King <wking@tremily.us> --- I'd also be happy just dropping the whole git-gc section ;).
Documentation/user-manual.txt | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-)
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 5077e7c..d14e3c7 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1562,17 +1562,13 @@ 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. +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 large +repositories may take some time, so you might want to disable +automatic comression and run it explicitly when you are not doing +other work. -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. [[ensuring-reliability]]
-- 1.8.1.336.g94702dd