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 <cornelius.weig@tngtech.com> Helped-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Cornelius Weig committed
Feb 1, 2017 at 23:07 UTC
67c70bd930538890d8eccace72fb0e0a0e565447
2 files changed
+6
Documentation/git-branch.txt
+3
@@ -91,6 +91,9 @@ OPTIONS
91
based sha1 expressions such as "<branchname>@\{yesterday}".
92
Note that in non-bare repositories, reflogs are usually
93
enabled by default by the `core.logallrefupdates` config option.
94
+ The negated form `--no-create-reflog` only overrides an earlier
95
+ `--create-reflog`, but currently does not negate the setting of
96
+ `core.logallrefupdates`.
97
98
-f::
99
--force::
Documentation/git-tag.txt
+3
@@ -152,6 +152,9 @@ This option is only applicable when listing tags without annotation lines.
152
--create-reflog::
153
Create a reflog for the tag. To globally enable reflogs for tags, see
154
`core.logAllRefUpdates` in linkgit:git-config[1].
155
+ The negated form `--no-create-reflog` only overrides an earlier
156
+ `--create-reflog`, but currently does not negate the setting of
157
+ `core.logallrefupdates`.
158
159
<tagname>::
160
The name of the tag to create, delete, or describe.