Re: [PATCH] doc: add note about ignoring --no-create-reflog

From: Jeff King <peff@peff.net>
Date: Feb 1, 2017, 23:32 UTC
Message-ID: <20170201233202.p462dggidiiyx6s6@sigill.intra.peff.net>
In-Reply-To: <xmqqefzhmr02.fsf@gitster.mtv.corp.google.com>

On Wed, Feb 01, 2017 at 03:27:09PM -0800, Junio C Hamano wrote:

Show 13 quoted lines

> I had the same trouble wording.  Another thing I noticed was that I
> deliberately left it vague what "default" this does not override,
> because it appears to me that those who do not set logallrefupdates
> will get the compiled-in default and that is also not overriden.
> 
> IOW, "does not negate the setting of core.logallrefupdates" will
> open us to reports "I do not have the configuration set, but I still
> get reflog even when --no-create-reflog is given".
> 
>    The negated form `--no-create-reflog` currently does not negate
>    the default; it overrides an earlier `--create-reflog`, though.
> 
> perhaps?

True. I thought the default was "off", and that we merely set the config when initializing a repo. But looking again, it really is checking is_bare_repository() at runtime.

I still think it is OK to mention, as the description of core.logallrefupdates is where we document the behavior and the defaults. So even with "I do not have it set", that is still the key to find more information.

I do not care that strongly either way, though. This is a minor issue, and I suspect just about any note would be helpful.

-Peff