kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

gc docs: change --keep-base-pack to --keep-largest-pack 

The --keep-base-pack option never existed in git.git. It was the name
for the --keep-largest-pack option in earlier revisions of that series
before it landed as ae4e89e549 ("gc: add --keep-largest-pack option",
2018-04-15).

The later patches in that series[1][2] weren't changed to also refer
to --keep-largest-pack, so we've had this reference to a nonexisting
option ever since the feature initially landed.

1. 55dfe13df9 ("gc: add gc.bigPackThreshold config", 2018-04-15)

2. 9806f5a7bf ("gc --auto: exclude base pack if not enough mem to
   "repack -ad"", 2018-04-15)

Reported-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Ævar Arnfjörð Bjarmason 2020-11-20 12:55:21 +01:00 committed by Junio C Hamano
parent 7397ca3373
commit db5368b846
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/config/gc.txt
View File

@ -44,9 +44,9 @@ gc.autoDetach::


gc.bigPackThreshold:: gc.bigPackThreshold::
If non-zero, all packs larger than this limit are kept when If non-zero, all packs larger than this limit are kept when
`git gc` is run. This is very similar to `--keep-base-pack` `git gc` is run. This is very similar to `--keep-largest-pack`
except that all packs that meet the threshold are kept, not except that all packs that meet the threshold are kept, not
just the base pack. Defaults to zero. Common unit suffixes of just the largest pack. Defaults to zero. Common unit suffixes of
'k', 'm', or 'g' are supported. 'k', 'm', or 'g' are supported.
+ +
Note that if the number of kept packs is more than gc.autoPackLimit, Note that if the number of kept packs is more than gc.autoPackLimit,
@ -57,7 +57,7 @@ gc.autoPackLimit and gc.bigPackThreshold should be respected again.
If the amount of memory estimated for `git repack` to run smoothly is If the amount of memory estimated for `git repack` to run smoothly is
not available and `gc.bigPackThreshold` is not set, the largest pack not available and `gc.bigPackThreshold` is not set, the largest pack
will also be excluded (this is the equivalent of running `git gc` with will also be excluded (this is the equivalent of running `git gc` with
`--keep-base-pack`). `--keep-largest-pack`).


gc.writeCommitGraph:: gc.writeCommitGraph::
If true, then gc will rewrite the commit-graph file when If true, then gc will rewrite the commit-graph file when