From: Kristoffer Haugsbakk Date: Mon, 21 Oct 2024 20:47:27 +0000 (+0200) Subject: Documentation/git-update-ref.txt: remove confusing paragraph X-Git-Tag: v2.48.0-rc0~75^2~2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=793e308f1ed8197764cce8b88b4ee4e7471287df;p=thirdparty%2Fgit.git 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 `` 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 Signed-off-by: Kristoffer Haugsbakk Signed-off-by: Taylor Blau --- diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 6aaa7339d7..61647ee841 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -25,10 +25,6 @@ value is . You can specify 40 "0" or an empty string as to make sure that the ref you are creating does not exist. -It also allows a "ref" file to be a symbolic pointer to another -ref file by starting with the four-byte header sequence of -"ref:". - If --no-deref is given, itself is overwritten, rather than the result of following the symbolic pointers.