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

From: Jeff King <peff@peff.net>
Date: Feb 1, 2017, 23:19 UTC
Message-ID: <20170201231939.hxhhujpzyb2cqq7a@sigill.intra.peff.net>
In-Reply-To: <xmqqmve5mrpe.fsf@gitster.mtv.corp.google.com>

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

Show 11 quoted lines

> diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
> index 5516a47b54..102e426fd8 100644
> --- a/Documentation/git-branch.txt
> +++ b/Documentation/git-branch.txt
> @@ -91,6 +91,9 @@ OPTIONS
>  	based sha1 expressions such as "<branchname>@\{yesterday}".
>  	Note that in non-bare repositories, reflogs are usually
>  	enabled by default by the `core.logallrefupdates` config option.
> +	The negated form `--no-create-reflog` does not override the
> +	default, even though it overrides `--create-reflog` that appears
> +	earlier on the command line.

Should this perhaps say "currently" or "this may change in the future", so that people (including those who might want to fix it later) know that it's a limitation and not intentional?

I'd also probably say it a little shorter, like:

  The negated form `--no-create-reflog` only overrides an earlier
  `--create-reflog`, but currently does not negate the setting of
  `core.logallrefupdates`.

I guess that really isn't much shorter (I wondered if you could cut out the "overrides --create-reflog" part, since that is the normal and expected behavior, but I had trouble wording it to do so).

-Peff