Skip to content

Commit db5368b

Browse files
avargitster
authored andcommitted
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 ae4e89e ("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. 55dfe13 ("gc: add gc.bigPackThreshold config", 2018-04-15) 2. 9806f5a ("gc --auto: exclude base pack if not enough mem to "repack -ad"", 2018-04-15) Reported-by: Luc Van Oostenryck <[email protected]> Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7397ca3 commit db5368b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Documentation/config/gc.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ gc.autoDetach::
4444

4545
gc.bigPackThreshold::
4646
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`
4848
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
5050
'k', 'm', or 'g' are supported.
5151
+
5252
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.
5757
If the amount of memory estimated for `git repack` to run smoothly is
5858
not available and `gc.bigPackThreshold` is not set, the largest pack
5959
will also be excluded (this is the equivalent of running `git gc` with
60-
`--keep-base-pack`).
60+
`--keep-largest-pack`).
6161

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

0 commit comments

Comments
 (0)