Documentation/config: mention "now" and "never" for 'expire' settings
In addition to approxidate-style values ("2.months.ago", "yesterday"), consumers of 'gc.*expire*' configuration variables also accept and respect 'now' ("do it immediately") and 'never' ("suppress entirely"). Suggested-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Eric Sunshine committed
Jul 28, 2015 at 16:06 UTC
8cc88166c00e555f1bf5375017ed91b7e2cc904e
1 file changed
+11
-5
Documentation/config.txt
+11
-5
@@ -1226,20 +1226,24 @@ gc.packrefs::
1226
gc.pruneexpire::
1227
When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1228
Override the grace period with this config variable. The value
1229
- "now" may be used to disable this grace period and always prune
1230
- unreachable objects immediately.
1229
+ "now" may be used to disable this grace period and always prune
1230
+ unreachable objects immediately, or "never" may be used to
1231
+ suppress pruning.
1232
1233
gc.worktreePruneExpire::
1234
When 'git gc' is run, it calls
1235
'git worktree prune --expire 3.months.ago'.
1236
This config variable can be used to set a different grace
1237
period. The value "now" may be used to disable the grace
1237
- period and prune $GIT_DIR/worktrees immediately.
1238
+ period and prune $GIT_DIR/worktrees immediately, or "never"
1239
+ may be used to suppress pruning.
1240
1241
gc.reflogexpire::
1242
gc.<pattern>.reflogexpire::
1243
'git reflog expire' removes reflog entries older than
1242
- this time; defaults to 90 days. With "<pattern>" (e.g.
1244
+ this time; defaults to 90 days. The value "now" expires all
1245
+ entries immediately, and "never" suppresses expiration
1246
+ altogether. With "<pattern>" (e.g.
1247
"refs/stash") in the middle the setting applies only to
1248
the refs that match the <pattern>.
1249
@@ -1247,7 +1251,9 @@ gc.reflogexpireunreachable::
1251
gc.<ref>.reflogexpireunreachable::
1252
'git reflog expire' removes reflog entries older than
1253
this time and are not reachable from the current tip;
1250
- defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1254
+ defaults to 30 days. The value "now" expires all entries
1255
+ immediately, and "never" suppresses expiration altogether.
1256
+ With "<pattern>" (e.g. "refs/stash")
1257
in the middle, the setting applies only to the refs that
1258
match the <pattern>.
1259