]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation/git-update-ref.txt: remove confusing paragraph
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Mon, 21 Oct 2024 20:47:27 +0000 (22:47 +0200)
committerTaylor Blau <me@ttaylorr.com>
Mon, 21 Oct 2024 20:49:31 +0000 (16:49 -0400)
commit793e308f1ed8197764cce8b88b4ee4e7471287df
treee2875268e0de1d67052d5e3f236f54cbd4ab6bb2
parentdc6050f67e33c29c3b2787a6b1aa419e54f19d76
Documentation/git-update-ref.txt: remove confusing paragraph

This paragraph interrupts the flow of the section by going into detail
about what a symbolic ref file is and how it is implemented.  It is not
clear what the purpose is since symbolic refs were already mentioned
prior (“possibly dereferencing the symbolic refs”).  Worse, it can
confuse the reader about what argument can be a symbolic ref since it
just says “it” and not which of the parameters; in turn the reader can
be lead to try `<new-oid>` and then get a confusing error since
update-ref will just say that it is not a valid SHA1.

gitglossary(7) already documents what a symref is, concretely, and quite
well at that.

Reported-by: Bence Ferdinandy <bence@ferdinandy.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Documentation/git-update-ref.txt