diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2024-10-21 22:47:25 +0200 |
|---|---|---|
| committer | Taylor Blau <me@ttaylorr.com> | 2024-10-21 16:49:31 -0400 |
| commit | 744c282cd4f92a6c9942131189f2dc722e3a1a2a (patch) | |
| tree | 0591af4f9d610a9291dc17aa7c39a51f008c1afd /Documentation | |
| parent | 1b2dfb70504285e67f22530b6d4c551d4cc4347e (diff) | |
| download | git-744c282cd4f92a6c9942131189f2dc722e3a1a2a.tar.xz | |
Documentation/git-update-ref.txt: remove safety paragraphs
Remove paragraphs which explain that using this command is safer than
echoing the branch name into `HEAD`.
Evoking the echo strategy is wrong now under the reftable backend since
this file does not exist. And the ref file backend majority user base
use porcelain commands to manage `HEAD` unless they are intentionally
poking at the implementation.
Maybe this warning was relevant for the usage patterns when it was
added[1] but now it just takes up space.
† 1: 129056370ab (Add missing documentation., 2005-10-04)
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-update-ref.txt | 15 |
1 files changed, 0 insertions, 15 deletions
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index a2bee2ea24..1a0aec041e 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -40,21 +40,6 @@ somewhere else with a regular filename). If --no-deref is given, <ref> itself is overwritten, rather than the result of following the symbolic pointers. -In general, using - - git update-ref HEAD "$head" - -should be a _lot_ safer than doing - - echo "$head" > "$GIT_DIR/HEAD" - -both from a symlink following standpoint *and* an error checking -standpoint. The "refs/" rule for symlinks means that symlinks -that point to "outside" the tree are safe: they'll be followed -for reading but not for writing (so we'll never write through a -ref symlink to some other tree, if you have copied a whole -archive by creating a symlink tree). - With `-d`, it deletes the named <ref> after verifying that it still contains <old-oid>. |