gc docs: modernize the advice for manually running "gc"

The docs have been recommending that users need to run this manually,
but that hasn't been needed in practice for a long time except in
exceptional circumstances.

Let's instead have this reflect reality and say that most users don't
need to run this manually at all, while briefly describing the sorts
sort of cases where "gc" does need to be run manually.

Since we're recommending that users run this most of the and usually
don't need to tweak it, let's tone down the very prominent example of
the gc.auto=0 command. It's sufficient to point to the gc.auto
documentation below.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2019-03-22 10:32:32 +01:00 committed by Junio C Hamano
parent 041f5ea1cf
commit b11e8560cc

View File

@ -20,17 +20,16 @@ created from prior invocations of 'git add', packing refs, pruning
reflog, rerere metadata or stale working trees. May also update ancillary reflog, rerere metadata or stale working trees. May also update ancillary
indexes such as the commit-graph. indexes such as the commit-graph.
Users are encouraged to run this task on a regular basis within When common porcelain operations that create objects are run, they
each repository to maintain good disk space utilization and good will check whether the repository has grown substantially since the
operating performance. last maintenance, and if so run `git gc` automatically. See `gc.auto`
below for how to disable this behavior.
Some git commands may automatically run 'git gc'; see the `--auto` flag Running `git gc` manually should only be needed when adding objects to
below for details. If you know what you're doing and all you want is to a repository without regularly running such porcelain commands, to do
disable this behavior permanently without further considerations, just do: a one-off repository optimization, or e.g. to clean up a suboptimal
mass-import. See the "PACKFILE OPTIMIZATION" section in
---------------------- linkgit:git-fast-import[1] for more details on the import case.
$ git config --global gc.auto 0
----------------------
OPTIONS OPTIONS
------- -------