gc docs: note how --aggressive impacts --window & --depth
Since 07e7dbf0db (gc: default aggressive depth to 50, 2016-08-11) we somewhat confusingly use the same depth under --aggressive as we do by default. As noted in that commit that makes sense, it was wrong to make more depth the default for "aggressive", and thus save disk space at the expense of runtime performance, which is usually the opposite of someone who'd like "aggressive gc" wants. But that's left us with a mostly-redundant configuration variable, so let's clearly note in its documentation that it doesn't change the default. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Apr 7, 2019 at 21:52 UTC
080a4480a07ae9831bf2685564641f6e5530cf87
1 file changed
+4
-2
Documentation/config/gc.txt
+4
-2
@@ -1,7 +1,8 @@
1
gc.aggressiveDepth::
2
The depth parameter used in the delta compression
3
algorithm used by 'git gc --aggressive'. This defaults
4
- to 50.
4
+ to 50, which is the default for the `--depth` option when
5
+ `--aggressive` isn't in use.
6
+
7
See the documentation for the `--depth` option in
8
linkgit:git-repack[1] for more details.
@@ -9,7 +10,8 @@ linkgit:git-repack[1] for more details.
10
gc.aggressiveWindow::
11
The window size parameter used in the delta compression
12
algorithm used by 'git gc --aggressive'. This defaults
12
- to 250.
13
+ to 250, which is a much more aggressive window size than
14
+ the default `--window` of 10.
15
+
16
See the documentation for the `--window` option in
17
linkgit:git-repack[1] for more details.