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>
Ævar Arnfjörð Bjarmason committed
Nov 20, 2020 at 12:55 UTC
db5368b846ac4c21f8d3bbc8e63c9b8d38ff19ff
1 file changed
+3
-3
Documentation/config/gc.txt
+3
-3
@@ -44,9 +44,9 @@ gc.autoDetach::
44
45
gc.bigPackThreshold::
46
If non-zero, all packs larger than this limit are kept when
47
- `git gc` is run. This is very similar to `--keep-base-pack`
47
+ `git gc` is run. This is very similar to `--keep-largest-pack`
48
except that all packs that meet the threshold are kept, not
49
- just the base pack. Defaults to zero. Common unit suffixes of
49
+ just the largest pack. Defaults to zero. Common unit suffixes of
50
'k', 'm', or 'g' are supported.
51
+
52
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.
57
If the amount of memory estimated for `git repack` to run smoothly is
58
not available and `gc.bigPackThreshold` is not set, the largest pack
59
will also be excluded (this is the equivalent of running `git gc` with
60
-`--keep-base-pack`).
60
+`--keep-largest-pack`).
61
62
gc.writeCommitGraph::
63
If true, then gc will rewrite the commit-graph file when