summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorDerrick Stolee <dstolee@microsoft.com>2020-09-17 18:11:49 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-09-17 18:30:05 (GMT)
commit65d655b52df3d4db0b4980f60106ed9785d025f8 (patch)
tree1d82985cbf7712a7da713d56a4711ee5c1dc1436 /Documentation/config
parentd7514f6ed57d20bcc9dcfb43016b95dba82ba790 (diff)
downloadgit-65d655b52df3d4db0b4980f60106ed9785d025f8.zip
git-65d655b52df3d4db0b4980f60106ed9785d025f8.tar.gz
git-65d655b52df3d4db0b4980f60106ed9785d025f8.tar.bz2
maintenance: create maintenance.<task>.enabled config
Currently, a normal run of "git maintenance run" will only run the 'gc' task, as it is the only one enabled. This is mostly for backwards- compatible reasons since "git maintenance run --auto" commands replaced previous "git gc --auto" commands after some Git processes. Users could manually run specific maintenance tasks by calling "git maintenance run --task=<task>" directly. Allow users to customize which steps are run automatically using config. The 'maintenance.<task>.enabled' option then can turn on these other tasks (or turn off the 'gc' task). Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/maintenance.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/config/maintenance.txt b/Documentation/config/maintenance.txt
new file mode 100644
index 0000000..4402b8b
--- /dev/null
+++ b/Documentation/config/maintenance.txt
@@ -0,0 +1,6 @@
+maintenance.<task>.enabled::
+ This boolean config option controls whether the maintenance task
+ with name `<task>` is run when no `--task` option is specified to
+ `git maintenance run`. These config values are ignored if a
+ `--task` option exists. By default, only `maintenance.gc.enabled`
+ is true.