[PATCH] doc: add note about ignoring --no-create-reflog
- From
- cornelius.weig@tngtech.com <cornelius.weig@tngtech.com>
- Date
- Feb 1, 2017, 22:07 UTC
- Message-ID
- <20170201220727.18070-1-cornelius.weig@tngtech.com>
From: Cornelius Weig <cornelius.weig@tngtech.com>
The commands git-branch and git-tag accept a `--create-reflog` argument. On the other hand, the negated form `--no-create-reflog` is accepted as a valid option but has no effect. This silent noop may puzzle users.
To communicate that this behavior is intentional, add a short note in the manuals for git-branch and git-tag.
Signed-off-by: Cornelius Weig <cornelius.weig@tngtech.com> ---
Notes:
In a previous discussion (<xmqqbmunrwbf.fsf@gitster.mtv.corp.google.com>) it
was found that git-branch and git-tag accept a "--no-create-reflog" argument,
but it has no effect, does not produce a warning, and is undocumented.Documentation/git-branch.txt | 1 + Documentation/git-tag.txt | 1 + 2 files changed, 2 insertions(+)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 1fae4ee..fca3754 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -91,6 +91,7 @@ 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` is silently ignored. -f:: --force:: diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 5b2288c..b0b933e 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -152,6 +152,7 @@ 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` is silently ignored. <tagname>:: The name of the tag to create, delete, or describe.
-- 2.10.2