git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	phillip.wood@dunelm.org.uk, gitster@pobox.com,
	bence@ferdinandy.com, karthik.188@gmail.com, me@ttaylorr.com,
	sunshine@sunshineco.com
Subject: [PATCH v3 2/6] Documentation/git-update-ref.txt: remove safety paragraphs
Date: Mon, 21 Oct 2024 22:47:25 +0200	[thread overview]
Message-ID: <bb14c427f81bbbdf6d6bb80e1bfd39e80f1d1c40.1729543007.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1729543007.git.code@khaugsbakk.name>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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>
---

Notes (series):
    v3:
    • Change commit message: ref backends
    
      Link: https://lore.kernel.org/git/bcb0e2d8-ebee-4835-aa43-05107199ee62@app.fastmail.com/#t

 Documentation/git-update-ref.txt | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index a2bee2ea24a..1a0aec041ea 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>.
 
-- 
2.46.1.641.g54e7913fcb6


  parent reply	other threads:[~2024-10-21 20:47 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11 20:51 ref: with git update-ref? Bence Ferdinandy
2024-10-11 20:56 ` Kristoffer Haugsbakk
2024-10-11 21:04   ` Bence Ferdinandy
2024-10-11 21:28     ` Junio C Hamano
2024-10-12 19:41       ` Bence Ferdinandy
2024-10-13  9:34       ` Phillip Wood
2024-10-13 10:07         ` Kristoffer Haugsbakk
2024-10-13 12:09           ` karthik nayak
2024-10-13 15:39             ` Kristoffer Haugsbakk
2024-10-13 20:40               ` Bence Ferdinandy
2024-10-14 15:06             ` Kristoffer Haugsbakk
2024-10-15 19:03             ` [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs kristofferhaugsbakk
2024-10-15 19:03               ` [PATCH 1/6] doc: update-ref: drop “flag” kristofferhaugsbakk
2024-10-16 20:45                 ` Taylor Blau
2024-10-16 22:08                   ` Eric Sunshine
2024-10-16 22:09                     ` Taylor Blau
2024-10-17 15:30                       ` Kristoffer Haugsbakk
2024-10-17 16:31                         ` Eric Sunshine
2024-10-17 18:50                           ` Taylor Blau
2024-10-15 19:03               ` [PATCH 2/6] doc: update-ref: remove safety paragraphs kristofferhaugsbakk
2024-10-16 20:47                 ` Taylor Blau
2024-10-15 19:03               ` [PATCH 3/6] doc: update-ref: demote symlink to last section kristofferhaugsbakk
2024-10-15 19:03               ` [PATCH 4/6] doc: update-ref: remove confusing paragraph kristofferhaugsbakk
2024-10-16 20:51                 ` Taylor Blau
2024-10-16 20:55                   ` Kristoffer Haugsbakk
2024-10-16 20:57                     ` Taylor Blau
2024-10-15 19:03               ` [PATCH 5/6] doc: update-ref: discuss symbolic links kristofferhaugsbakk
2024-10-15 19:08                 ` Kristoffer Haugsbakk
2024-10-16 20:52                   ` Taylor Blau
2024-10-15 19:03               ` [PATCH 6/6] doc: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-16  8:51               ` [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs Bence Ferdinandy
2024-10-16 20:54               ` Taylor Blau
2024-10-16 21:00                 ` Kristoffer Haugsbakk
2024-10-19 19:59               ` [PATCH v2 " kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-20 11:09                   ` karthik nayak
2024-10-19 19:59                 ` [PATCH v2 2/6] Documentation/git-update-ref.txt: remove safety paragraphs kristofferhaugsbakk
2024-10-20 11:13                   ` karthik nayak
2024-10-20 12:30                     ` Kristoffer Haugsbakk
2024-10-20 16:24                     ` Kristoffer Haugsbakk
2024-10-19 19:59                 ` [PATCH v2 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-20 11:16                 ` [PATCH v2 0/6] doc: update-ref: amend old material and discuss symrefs karthik nayak
2024-10-21 20:47                 ` [PATCH v3 " kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-21 20:47                   ` kristofferhaugsbakk [this message]
2024-10-21 20:47                   ` [PATCH v3 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-21 20:50                   ` [PATCH v3 0/6] doc: update-ref: amend old material and discuss symrefs Taylor Blau
2024-10-12  6:25 ` ref: with git update-ref? Andreas Schwab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bb14c427f81bbbdf6d6bb80e1bfd39e80f1d1c40.1729543007.git.code@khaugsbakk.name \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=bence@ferdinandy.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=karthik.188@gmail.com \
    --cc=me@ttaylorr.com \
    --cc=phillip.wood@dunelm.org.uk \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).