diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2024-10-21 22:47:28 +0200 |
|---|---|---|
| committer | Taylor Blau <me@ttaylorr.com> | 2024-10-21 16:49:31 -0400 |
| commit | 74522b6b12ead82d4e9a39771b8a5cf287e0cb4a (patch) | |
| tree | 52a9b94ea0c34a1437af0b293e045230c87137ea | |
| parent | 793e308f1ed8197764cce8b88b4ee4e7471287df (diff) | |
| download | git-74522b6b12ead82d4e9a39771b8a5cf287e0cb4a.tar.gz | |
Documentation/git-update-ref.txt: discuss symbolic refs
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 `<new-oid>` and `<old-oid>` but the right balance
of redundancy makes documentation robust against stray interpretation.
This is also a good place to mention why `--stdin` has those `symref-*`
commands.
Suggested-by: Bence Ferdinandy <bence@ferdinandy.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
| -rw-r--r-- | Documentation/git-update-ref.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 61647ee841..2e85f7ce3e 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -25,6 +25,12 @@ value is <old-oid>. You can specify 40 "0" or an empty string as <old-oid> 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 `symref-*` commands so that regular refs and symbolic refs can be +committed in the same transaction. + If --no-deref is given, <ref> itself is overwritten, rather than the result of following the symbolic pointers. |