threads / bug / 50957

doc bug: update-ref --create-reflog also works with --stdin

Subject: doc bug: update-ref --create-reflog also works with --stdin

## tl;dr

2 messages between Apr 20, 2019 and Apr 21, 2019.

replies: 1people: 2as markdown or json

Chris Jerdonek· Apr 20, 2019, 01:01 UTC · lore

This is to report a bug in the docs, or at least suggest an improvement.

The update-ref documentation says that --create-reflog can only be passed when providing a new ref to create and doesn't say it can also be used with --stdin:

'git update-ref' [-m <reason>] [--no-deref] (-d <ref> [<oldvalue>] | [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])

from: https://github.com/git/git/blob/ffac537e6cbbf934b08745a378932722df287a53/Documentation/git-update-ref.txt#L11

My testing shows that it also works with --stdin, so it seems like it would help to document this.

Thanks, --Chris

Junio C Hamano· Apr 21, 2019, 05:13 UTC · re: Chris Jerdonek · lore

Re: doc bug: update-ref --create-reflog also works with --stdin

Chris Jerdonek <chris.jerdonek@gmail.com> writes:

> The update-ref documentation says that --create-reflog can only be
> passed when providing a new ref to create and doesn't say it can also
> be used with --stdin:

True. It instead should say that it only makes sense when creating a new ref; it does not matter where the names of new refs come from.