Re: [PATCH 2/6] Documentation/config: mention "now" and "never" for 'expire' settings

[Michael Haggerty <mhagger@alum.mit.edu>]

On 07/23/2015 09:00 PM, Eric Sunshine wrote:
> In addition to approxidate-style values ("2.months.ago", "yesterday"),
> consumers of 'gc.*expire*' configuration variables also accept and
> respect 'now'/'all' ("do it immediately") and 'never'/'false' ("suppress
> entirely").
> 
> Suggested-by: Michael Haggerty <mhagger@alum.mit.edu>
> Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
> ---
> 
> Reference: http://article.gmane.org/gmane.comp.version-control.git/274325
> 
> I sneaked in a minor whitespace fix.
> 
>  Documentation/config.txt | 13 ++++++++-----
>  1 file changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 1a8a399..cc920c0 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1307,20 +1307,22 @@ 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
> -	"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" to suppress pruning.

A semicolon should be used without a conjunction, and the parts of a
sentence joined by a semicolon should be independent clauses. So this
should probably be

                                                     [...] The value
    "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
> -	period and prune $GIT_DIR/worktrees immediately.
> +	period and prune $GIT_DIR/worktrees immediately; or "never" to
> +	suppress pruning.

The same here.

>  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 "all" expires all
> +	entries; and "false" disables expiration. With "<pattern>" (e.g.
>  	"refs/stash") in the middle the setting applies only to
>  	the refs that match the <pattern>.

Similarly, this could be fixed to

                               [...] The value "all" expires all
    entries; "false" disables expiration. [...]


> @@ -1328,7 +1330,8 @@ gc.reflogExpireUnreachable::
>  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 "all" expires all entries; and
> +	"false" disables expiration. With "<pattern>" (e.g. "refs/stash")
>  	in the middle, the setting applies only to the refs that
>  	match the <pattern>.

The same here.

Also, I wonder why you suggest "now"/"never" for the first two settings,
but "all"/"false" for the second two. Wouldn't it be less confusing to
be consistent?

Michael

-- 
Michael Haggerty
mhagger@alum.mit.edu