From 67c70bd930538890d8eccace72fb0e0a0e565447 Mon Sep 17 00:00:00 2001 From: Cornelius Weig Date: Wed, 1 Feb 2017 23:07:27 +0100 Subject: doc: add note about ignoring '--no-create-reflog' The commands git-branch and git-tag accept the '--create-reflog' option, and create reflog even when core.logallrefupdates configuration is explicitly set not to. On the other hand, the negated form '--no-create-reflog' is accepted as a valid option but has no effect (other than overriding an earlier '--create-reflog' on the command line). This silent noop may puzzle users. To communicate that this is a known limitation, add a short note in the manuals for git-branch and git-tag. Signed-off-by: Cornelius Weig Helped-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/git-branch.txt | 3 +++ Documentation/git-tag.txt | 3 +++ 2 files changed, 6 insertions(+) diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 5516a47b54..28d46cc03b 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -91,6 +91,9 @@ OPTIONS based sha1 expressions such as "@\{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` only overrides an earlier + `--create-reflog`, but currently does not negate the setting of + `core.logallrefupdates`. -f:: --force:: diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 2ac25a9bb3..1d2e9a05f6 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -152,6 +152,9 @@ This option is only applicable when listing tags without annotation lines. --create-reflog:: Create a reflog for the tag. To globally enable reflogs for tags, see `core.logAllRefUpdates` in linkgit:git-config[1]. + The negated form `--no-create-reflog` only overrides an earlier + `--create-reflog`, but currently does not negate the setting of + `core.logallrefupdates`. :: The name of the tag to create, delete, or describe. -- cgit v1.2.3