| Message ID | 20201120115522.23617-1-avarab@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | db5368b846ac4c21f8d3bbc8e63c9b8d38ff19ff |
| Headers | show |
| Series | [1/2] gc docs: change --keep-base-pack to --keep-largest-pack | expand |
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes: > 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). Is it a sign that this hasn't been used by or useful to our users that this documentation bug did not get noticed by anybody for the past 30 months, I wonder. "git gc -h" does report the option with correct name, which is the beauty of automation ;-) Thanks, both. Will queue, together with [2/2] which also makes sense.
On Sat, Nov 21 2020, Junio C Hamano wrote: > Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes: > >> 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). > > Is it a sign that this hasn't been used by or useful to our users > that this documentation bug did not get noticed by anybody for the > past 30 months, I wonder. FWIW I used it in a major git deployment since before it landed on "master" as gc.bigPackThreshold, but not the CLI option. I think a lot of these CLI options for gc/repack are relatively unused compared to the config, but it's still arguably useful to have them for one-off testing (although you could also just use "git -c ..."). > "git gc -h" does report the option with correct name, which is the > beauty of automation ;-) > > Thanks, both. Will queue, together with [2/2] which also makes > sense.
diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.txt index 00ea0a678e..c834e07991 100644 --- a/Documentation/config/gc.txt +++ b/Documentation/config/gc.txt @@ -44,9 +44,9 @@ gc.autoDetach:: gc.bigPackThreshold:: 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 - 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. + 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 not available and `gc.bigPackThreshold` is not set, the largest pack will also be excluded (this is the equivalent of running `git gc` with -`--keep-base-pack`). +`--keep-largest-pack`). gc.writeCommitGraph:: If true, then gc will rewrite the commit-graph file when
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> --- Documentation/config/gc.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)