Skip to content

Commit 793e308

Browse files
LemmingAvalanchettaylorr
authored andcommitted
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 <[email protected]> Signed-off-by: Kristoffer Haugsbakk <[email protected]> Signed-off-by: Taylor Blau <[email protected]>
1 parent dc6050f commit 793e308

File tree

1 file changed

+0
-4
lines changed

1 file changed

+0
-4
lines changed

Documentation/git-update-ref.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@ value is <old-oid>. You can specify 40 "0" or an empty string
2525
as <old-oid> to make sure that the ref you are creating does
2626
not exist.
2727

28-
It also allows a "ref" file to be a symbolic pointer to another
29-
ref file by starting with the four-byte header sequence of
30-
"ref:".
31-
3228
If --no-deref is given, <ref> itself is overwritten, rather than
3329
the result of following the symbolic pointers.
3430

0 commit comments

Comments
 (0)