diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2024-10-21 22:47:27 +0200 |
|---|---|---|
| committer | Taylor Blau <me@ttaylorr.com> | 2024-10-21 16:49:31 -0400 |
| commit | 793e308f1ed8197764cce8b88b4ee4e7471287df (patch) | |
| tree | e2875268e0de1d67052d5e3f236f54cbd4ab6bb2 /builtin/commit.c | |
| parent | dc6050f67e33c29c3b2787a6b1aa419e54f19d76 (diff) | |
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>
Diffstat (limited to 'builtin/commit.c')
0 files changed, 0 insertions, 0 deletions