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>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 583d24fda4054093c2ba7780581c5414dd983b2f..e09ee02df87359cdb92f8e2b3a6cabbce5456148 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1226,20 +1226,24 @@ gc.packrefs::
 gc.pruneexpire::
        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
        Override the grace period with this config variable.  The value
 gc.pruneexpire::
        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
        Override the grace period with this config variable.  The value

-       "now" may be used to disable this  grace period and always prune
-       unreachable objects immediately.
+       "now" may be used to disable this grace period and always prune
+       unreachable objects immediately, or "never" may be used to
+       suppress pruning.

 
 gc.worktreePruneExpire::
        When 'git gc' is run, it calls
        'git worktree prune --expire 3.months.ago'.
        This config variable can be used to set a different grace
        period. The value "now" may be used to disable the grace
 
 gc.worktreePruneExpire::
        When 'git gc' is run, it calls
        'git worktree prune --expire 3.months.ago'.
        This config variable can be used to set a different grace
        period. The value "now" may be used to disable the grace

-       period and prune $GIT_DIR/worktrees immediately.
+       period and prune $GIT_DIR/worktrees immediately, or "never"
+       may be used to suppress pruning.

 
 gc.reflogexpire::
 gc.<pattern>.reflogexpire::
        'git reflog expire' removes reflog entries older than
 
 gc.reflogexpire::
 gc.<pattern>.reflogexpire::
        'git reflog expire' removes reflog entries older than

-       this time; defaults to 90 days.  With "<pattern>" (e.g.
+       this time; defaults to 90 days. The value "now" expires all
+       entries immediately, and "never" suppresses expiration
+       altogether. With "<pattern>" (e.g.

        "refs/stash") in the middle the setting applies only to
        the refs that match the <pattern>.
 
        "refs/stash") in the middle the setting applies only to
        the refs that match the <pattern>.
 


@@ -1247,7 +1251,9 @@ gc.reflogexpireunreachable::
 gc.<ref>.reflogexpireunreachable::
        'git reflog expire' removes reflog entries older than
        this time and are not reachable from the current tip;
 gc.<ref>.reflogexpireunreachable::
        'git reflog expire' removes reflog entries older than
        this time and are not reachable from the current tip;

-       defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
+       defaults to 30 days. The value "now" expires all entries
+       immediately, and "never" suppresses expiration altogether.
+       With "<pattern>" (e.g. "refs/stash")

        in the middle, the setting applies only to the refs that
        match the <pattern>.
 
        in the middle, the setting applies only to the refs that
        match the <pattern>.