From: kristofferhaugsbakk@fastmail.com Date: Tue, 15 Oct 2024 19:03:14 GMT Subject: [PATCH 5/6] doc: update-ref: discuss symbolic links Message-ID: <3575fb48c932f50b2a3f6fb0e582b3c2a9b087af.1729017728.git.code@khaugsbakk.name> In-Reply-To: From: Kristoffer Haugsbakk Add a paragraph which just emphasizes that the command without any options does not support refs in the final arguments. This is clear already from the names `` and `` but the right balance of redundancy makes documentation robust to stray interpretation. This is also a good place to mention why `--stdin` has those `symref-*` commands. Signed-off-by: Kristoffer Haugsbakk --- Documentation/git-update-ref.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 4bb3389cc7c..623c4d860eb 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -25,6 +25,12 @@ value is . You can specify 40 "0" or an empty string as to make sure that the ref you are creating does not exist. +The final arguments are object names; this command without any options +does not support updating a symbolic ref to point to another ref (see +linkgit:git-symbolic-ref[1]). But `git update-ref --stdin` does have +the the `symref-*` commands so that regular refs and symbolic refs can +be committed in the same transaction. + If --no-deref is given, itself is overwritten, rather than the result of following the symbolic pointers. -- 2.46.1.641.g54e7913fcb6