[v3,09/11] gc docs: note "gc --aggressive" in "fast-import"

Message ID	20190322093242.5508-10-avarab@gmail.com (mailing list archive)
State	New, archived
Headers	show Return-Path: <git-owner@kernel.org> From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> To: git@vger.kernel.org Cc: Junio C Hamano <gitster@pobox.com>, =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmc=?= =?utf-8?b?4buNYyBEdXk=?= <pclouds@gmail.com>, Jeff King <peff@peff.net>, Michael Haggerty <mhagger@alum.mit.edu>, Stefan Beller <stefanbeller@gmail.com>, Jonathan Nieder <jrnieder@gmail.com>, Matt McCutchen <matt@mattmccutchen.net>, Johannes Sixt <j6t@kdbg.org>, =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> Subject: [PATCH v3 09/11] gc docs: note "gc --aggressive" in "fast-import" Date: Fri, 22 Mar 2019 10:32:40 +0100 Message-Id: <20190322093242.5508-10-avarab@gmail.com> In-Reply-To: <20190321205054.17109-1-avarab@gmail.com> References: <20190321205054.17109-1-avarab@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: git-owner@vger.kernel.org Precedence: bulk
Series	gc docs: modernize and fix the documentation \| expand [v2,00/10] gc docs: modernize and fix the documentation [v3,01/11] gc docs: modernize the advice for manually running "gc" [v3,02/11] gc docs: stop noting "repack" flags [v3,03/11] gc docs: clean grammar for "gc.bigPackThreshold" [v3,04/11] gc docs: include the "gc." section from "config" in "gc" [v3,05/11] gc docs: re-flow the "gc." section in "config" [v3,06/11] gc docs: fix formatting for "gc.writeCommitGraph" [v3,07/11] gc docs: note how --aggressive impacts --window & --depth [v3,08/11] gc docs: downplay the usefulness of --aggressive [v3,09/11] gc docs: note "gc --aggressive" in "fast-import" [v3,10/11] gc docs: clarify that "gc" doesn't throw away referenced objects [v3,11/11] gc docs: remove incorrect reference to gc.auto=0

Message ID

20190322093242.5508-10-avarab@gmail.com (mailing list archive)

State

New, archived

Headers

From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?=  <avarab@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmc=?=
	=?utf-8?b?4buNYyBEdXk=?=  <pclouds@gmail.com>, Jeff King <peff@peff.net>,
 Michael Haggerty <mhagger@alum.mit.edu>,
 Stefan Beller <stefanbeller@gmail.com>, Jonathan Nieder <jrnieder@gmail.com>,
 Matt McCutchen <matt@mattmccutchen.net>, Johannes Sixt <j6t@kdbg.org>,
	=?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?=  <avarab@gmail.com>
Subject: [PATCH v3 09/11] gc docs: note "gc --aggressive" in "fast-import"
Date: Fri, 22 Mar 2019 10:32:40 +0100
Message-Id: <20190322093242.5508-10-avarab@gmail.com>
In-Reply-To: <20190321205054.17109-1-avarab@gmail.com>
References: <20190321205054.17109-1-avarab@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Sender: git-owner@vger.kernel.org
Precedence: bulk

Series

gc docs: modernize and fix the documentation | expand

Commit Message

Ævar Arnfjörð Bjarmason March 22, 2019, 9:32 a.m. UTC

Amend the "PACKFILE OPTIMIZATION" section in "fast-import" to explain
that simply running "git gc --aggressive" after a "fast-import" should
properly optimize the repository. This is simpler and more effective
than the existing "repack" advice (which I'm keeping as it helps
explain things) because it e.g. also packs the newly imported refs.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/git-fast-import.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 43ab3b1637..2248755cb7 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -1396,6 +1396,13 @@  deltas are suboptimal (see above) then also adding the `-f` option
 to force recomputation of all deltas can significantly reduce the
 final packfile size (30-50% smaller can be quite typical).
 
+Instead of running `git repack` you can also run `git gc
+--aggressive`, which will also optimize other things after an import
+(e.g. pack loose refs). As noted in the "AGGRESSIVE" section in
+linkgit:git-gc[1] the `--aggressive` option will find new deltas with
+the `-f` option to linkgit:git-repack[1]. For the reasons elaborated
+on above using `--aggressive` after a fast-import is one of the few
+cases where it's known to be worthwhile.
 
 MEMORY UTILIZATION
 ------------------

[v3,09/11] gc docs: note "gc --aggressive" in "fast-import"

Commit Message

Patch