From patchwork Sat Oct 19 19:59:18 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842880
Received: from fout-b7-smtp.messagingengine.com
 (fout-b7-smtp.messagingengine.com [202.12.124.150])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 067D8191F88
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:15 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.150
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368018; cv=none;
 b=uGsKPkOPzxpa1GoyA7PQEJZiEkM4OBGYJmSBYzMVcsc2xVCQGXPKW5k10EKX2Otc7KgeTcg6uUGjKcA5F7XxWfbteWqZ8eqYqZtGKCQzoLgtFww/D5jSZyNLBUEVlPkSq9paG1z9V+iRkLVFwmDckM8h3iotwjuwWTnOH9ut6Vo=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368018; c=relaxed/simple;
	bh=chLQwNz3xs/H16nhjkyS3P/EGl+FJ9vMm38yIsq7iuQ=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version:Content-Type;
 b=JZimDeAXkgq0kAFAKk9Kv6lvYRAP6AmD0fsru92c09k1lnSV3rXRSwoPLvkOunx5tlSZxwCntxBKowufFnhbO28fC47e/BcyzEEWx5T9dUbDvhnI+fVdWS2eaDwj/QhbQizQbDz5sTMtbSegRBIU1K3H/b7J54HLczOc40Tw5sU=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=QA73jxit;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=DJJcYS52; arc=none smtp.client-ip=202.12.124.150
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="QA73jxit";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="DJJcYS52"
Received: from phl-compute-03.internal (phl-compute-03.phl.internal
 [10.202.2.43])
	by mailfout.stl.internal (Postfix) with ESMTP id E6450114009A;
	Sat, 19 Oct 2024 16:00:14 -0400 (EDT)
Received: from phl-mailfrontend-01 ([10.202.2.162])
  by phl-compute-03.internal (MEProxy); Sat, 19 Oct 2024 16:00:15 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:content-type:date
	:date:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to; s=fm2; t=1729368014;
	 x=1729454414; bh=Z14gVIs4Y8c//RffccW3WyNzl67TwhP/w6enOp1t+kQ=; b=
	QA73jxita4VBffj8bR/NBoTAOmfbwc+YUGaySssZ3kfkYj4Qb21b8dnUitL/+XdJ
	1NG48FuvBKMciYsQ6SDYfuOUAXm+zTLnRYAR3WZjhFXV29FAQNqQz5Xaqk+PJJrT
	5WLUqFGw8WYOsL43mwKGETxxYcpfeqG4hf5TsnUY3SbfUaFKKGxYrllZS9Xb+VMA
	yHa9RQ9uaV8QCPz0t4/u5zCRmJ45GE97Ycf1rtrfzjF2ObPKa9ULnR6DiTC06ltI
	z3z8Fi+HRYPjeC3OCzvX2LJAhf69pSFd5pjHeSAvKY6WOzhYL0BZZ6jg1kmdEcu4
	zPiZB1FJew83ZZCBmnJdYg==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:content-type:date:date:feedback-id:feedback-id
	:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368014; x=
	1729454414; bh=Z14gVIs4Y8c//RffccW3WyNzl67TwhP/w6enOp1t+kQ=; b=D
	JJcYS52G0m0G4V079H9bG53ljLJgZiWW2180JsW2CbXBMJVZt8mMS4WuvTjqNnre
	GQKiDPOmuebZAWl9c9WgmUHM34aPYM/8jzoMwhy3pn0Rx4Fx060eIkmrV5/U01PK
	y6lYIwXeyhpwjXunP0j1EUYvcFP79zfc+3WTSBr7Ga73oQ67lypFOo1p7V5XWRnP
	XXEIELtlayhVL48xaDBQNKuk9SGeZFeXVH0znrrTF4rPWBvnpSTGngmjDo+jQbEY
	ZQ+BARXmyMk51jdbP/Kx4rfvgljHe3ignJN++mS7Lnr9TwrY7GQtddTJB7V3wqqf
	cCgeZIqVjLO5YrFwGYZLg==
X-ME-Sender: <xms:zg8UZ5KdLEG83XA7sL3_F9iSFjQhTgjD7pOSegVBWDZEmAc86z0836c>
    <xme:zg8UZ1JfHvyw_ipmHcso9yYgNpy2T7mWAzbTqjOcmaupqSWLV0WsZpI7E-5Sz4wN8
    KMSSc9JoeHeoSKubA>
X-ME-Received: 
 <xmr:zg8UZxuaipUDFtPSnhkTCZ08o--Jm2tfHOm1vqQjem0Dimtl68K6it7xEyzYvicvqbezRBeCWOxerwTalIPy-r7wlmBZxpw5VY9YowgIQ3wU2jBryuJ2pUz10Q>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegiecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhggtgfgsehtkeertdertdejnecuhfhrohhmpehkrhhishhtohhffhgvrhhh
    rghughhssggrkhhksehfrghsthhmrghilhdrtghomhenucggtffrrghtthgvrhhnpefhgf
    eglefhjeekgfetleetjefhteeiheegfedtudduffegjefhkeetudeggffhkeenucevlhhu
    shhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehkrhhishhtohhffh
    gvrhhhrghughhssggrkhhksehfrghsthhmrghilhdrtghomhdpnhgspghrtghpthhtohep
    kedpmhhouggvpehsmhhtphhouhhtpdhrtghpthhtohepghhithesvhhgvghrrdhkvghrnh
    gvlhdrohhrghdprhgtphhtthhopegtohguvgeskhhhrghughhssggrkhhkrdhnrghmvgdp
    rhgtphhtthhopehphhhilhhlihhprdifohhougesughunhgvlhhmrdhorhhgrdhukhdprh
    gtphhtthhopehgihhtshhtvghrsehpohgsohigrdgtohhmpdhrtghpthhtohepsggvnhgt
    vgesfhgvrhguihhnrghnugihrdgtohhmpdhrtghpthhtohepkhgrrhhthhhikhdrudekke
    esghhmrghilhdrtghomhdprhgtphhtthhopehmvgesthhtrgihlhhorhhrrdgtohhmpdhr
    tghpthhtohepshhunhhshhhinhgvsehsuhhnshhhihhnvggtohdrtghomh
X-ME-Proxy: <xmx:zg8UZ6ZLP_IffBn82WyEMAuc1GHr4vx929bjYjov9lxAbSjKD6l4DA>
    <xmx:zg8UZwYeNvA_4zaS6a8m2VkoqeuPiqYxlyayL_1fMLaHMDeAyh0mAw>
    <xmx:zg8UZ-DIckidvPivUHDR0hAGqrGx9QtcnNBFX-bJotcmMMUemnKbCA>
    <xmx:zg8UZ-ZYdtr9jYHne0LmyPz3MRMDFyC51Qim03RFEqj7iB3s2a8M6g>
    <xmx:zg8UZ2M_UDlpveAbzumEa7Jd8rQTo68U1mBSS8nh9dgx2n9pA5JhgGvK>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:12 -0400 (EDT)
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 v2 1/6] =?utf-8?q?Documentation/git-update-ref=2Etxt=3A_drop?=
	=?utf-8?q?_=E2=80=9Cflag=E2=80=9D?=
Date: Sat, 19 Oct 2024 21:59:18 +0200
Message-ID: 
 <91c1cae32098e82033f9b20ead6d1bc8e315da22.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: 91c1cae32098e82033f9b20ead6d1bc8e315da22
X-Previous-Commits: ad9ee00a2a971522968f95dd413deae24839ef71

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

The other paragraphs on options say “With <option>,”.  Let’s be uniform.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v2:
    • Message: tweak
    • Not done: paragraph wrapping.  I found something else in this
      paragraph: missing “that”: “after verifying *that*”.  I will fix that
      in an upcoming series since there were four other missing instances of
      this word and I did not want to add another patch to this series.

 Documentation/git-update-ref.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index afcf33cf608..fe5967234e9 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -55,7 +55,7 @@ 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` flag, it deletes the named <ref> after verifying it
+With `-d`, it deletes the named <ref> after verifying it
 still contains <old-oid>.
 
 With `--stdin`, update-ref reads instructions from standard input and

From patchwork Sat Oct 19 19:59:19 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842881
Received: from fhigh-b3-smtp.messagingengine.com
 (fhigh-b3-smtp.messagingengine.com [202.12.124.154])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 77B781922D9
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:20 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.154
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368022; cv=none;
 b=HcbJbySE1UYy7F0qWArJzuClae2FETbK0/NU+qFtjvoW5fWf5GOyVmUf6tGFVPpOCi7BkM6yBnkyNMd5pPP6PpoUwwwNfs4CmO0reCMb/fbsbOSbsflVIiuxGmWYxx1wVDZcYpCdxrOm8NDCAakD8jnpE/OVtbf+hnlIHbjj9/E=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368022; c=relaxed/simple;
	bh=Vc70rSkACb+z9LN3VBa9wiuQtXp+uCaKgpKZHMWS284=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version:Content-Type;
 b=VJ2yRNBUwVP0M6/fq3hd+TC3YdrVlCJPwcXk5bDqhkQpPsU831H/WNV0ag6mmwfmLRY+rXZSfjVXDdkinMxIb8c7hrw8UEnkxzSL44Nu6iik3yt1tY8l//pVkNFKngHAm9YI4gXylfY2jeDS9+vVC0Snnk9E8GqS5vb/+Go7YL8=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=JeLaeVzd;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=mov3t9Ti; arc=none smtp.client-ip=202.12.124.154
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="JeLaeVzd";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="mov3t9Ti"
Received: from phl-compute-11.internal (phl-compute-11.phl.internal
 [10.202.2.51])
	by mailfhigh.stl.internal (Postfix) with ESMTP id 619FD2540078;
	Sat, 19 Oct 2024 16:00:19 -0400 (EDT)
Received: from phl-mailfrontend-01 ([10.202.2.162])
  by phl-compute-11.internal (MEProxy); Sat, 19 Oct 2024 16:00:19 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:content-type:date
	:date:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to; s=fm2; t=1729368019;
	 x=1729454419; bh=Bhrv7252ZG4qY1DnpP0qMysTLtZ7/itaY1GIjmU7wzQ=; b=
	JeLaeVzdg15NNpCGJk+Ih1qMZae0z/CuEo50cku6Uctm1+Wtjhsn8nrTncMowdwt
	OrV5k5caVQb15LWSljZxUjNc6TzCgVdF9IYWmwW3jhKeRovsrr7vNwoA4mKnzTx9
	0Kylv8KcXmqODzEz8x1QGc0oUPD1Vx9Mq57JCwqrEpdjVyWCtHeU/Tjjk2bjNEFp
	HudOYbxaQc4e3HJsmUYdWU5oqUEvcyGD9tzuFYoaJqIw8A/QWZ0hVSfk0pawosbf
	o+CMekJFWvPOTsac1dJJ+ggJrv6dfKOEBpWLbPMpU6qvnuJt7IMwQnKOhgFn5+UA
	Z6i5l+AtYsjlkmOWS+m2QQ==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:content-type:date:date:feedback-id:feedback-id
	:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368019; x=
	1729454419; bh=Bhrv7252ZG4qY1DnpP0qMysTLtZ7/itaY1GIjmU7wzQ=; b=m
	ov3t9Ti9jJFIYW6WkuG0SlEBWLJo48quCeSfClfgVGQ9NdObmpIKbGqlEv932UlO
	E6awySw0mjgpbNLeJ8g55cUQoAvMXRx4Ou4229y/eXhu/jkHkylGH391MuGH2Y/4
	BnbUBlnVH27XIZCnbKVz9IOqEdU4a4jq5vSq/Ovw2khUbUfjDPoeXEpM4VNPSIaw
	jtzqxr3mdXvPtQa1dNBWCzmUEDg6CtpnfpDTam0Z7aIcHylfuwm3o7EkRQ4jE2UF
	tgLFurJ8G7IIhD07s4saDiH4w+SFsj5plfNqqou1i55YuvjpkG+bkXyXoZ0Kqqbb
	e1u4B3bV8krnZ+r/UVDJw==
X-ME-Sender: <xms:0w8UZ9_5wCjutZiOWEU0EE4vVPVVP483Dy7lcA1kj9yiMEFFLDPu02c>
    <xme:0w8UZxvaMr5zbQmcFtgNq0vUMRwdp9AI8CPCjOMxF8RAECxDlKonTjfJiWhKdK13t
    jaN7SAMPw8-6rc5gg>
X-ME-Received: 
 <xmr:0w8UZ7B33x2ouvKCIwJByFRPwc5xDaUU52K4Egh0PKq5xvqAho7TU_-JOgiuf744thOU4oxfrgnokahnFbKo-r2RKDuI9jppVJ0aK0crLyPP0MDcFdyF-aCBMQ>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegiecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhggtgfgsehtkeertdertdejnecuhfhrohhmpehkrhhishhtohhffhgvrhhh
    rghughhssggrkhhksehfrghsthhmrghilhdrtghomhenucggtffrrghtthgvrhhnpefhgf
    eglefhjeekgfetleetjefhteeiheegfedtudduffegjefhkeetudeggffhkeenucevlhhu
    shhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehkrhhishhtohhffh
    gvrhhhrghughhssggrkhhksehfrghsthhmrghilhdrtghomhdpnhgspghrtghpthhtohep
    kedpmhhouggvpehsmhhtphhouhhtpdhrtghpthhtohepghhithesvhhgvghrrdhkvghrnh
    gvlhdrohhrghdprhgtphhtthhopegtohguvgeskhhhrghughhssggrkhhkrdhnrghmvgdp
    rhgtphhtthhopehphhhilhhlihhprdifohhougesughunhgvlhhmrdhorhhgrdhukhdprh
    gtphhtthhopehgihhtshhtvghrsehpohgsohigrdgtohhmpdhrtghpthhtohepsggvnhgt
    vgesfhgvrhguihhnrghnugihrdgtohhmpdhrtghpthhtohepkhgrrhhthhhikhdrudekke
    esghhmrghilhdrtghomhdprhgtphhtthhopehmvgesthhtrgihlhhorhhrrdgtohhmpdhr
    tghpthhtohepshhunhhshhhinhgvsehsuhhnshhhihhnvggtohdrtghomh
X-ME-Proxy: <xmx:0w8UZxeC0bgcWRBTMCicsbG2pu1TuRfq5NE5Hqq6oK7KHCT7IeIptQ>
    <xmx:0w8UZyPSjAflKrTzHHMXB68Ly1hWoQbyDSSX4MwVhI4l4pSy9adCXg>
    <xmx:0w8UZzmH607pedZLUd1ulyNHTev0hWUMTE3BETR7ticV1kCz5_HjmQ>
    <xmx:0w8UZ8ta777z9Kd6O6ES80wePVf5xkHqsDyRRpeap0Vj5-2IefrUNQ>
    <xmx:0w8UZzisG8jD_2-OknkRWc_hgB8f6JIFURX1bgrPfIAKY9M7CO2htlMx>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:17 -0400 (EDT)
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 v2 2/6] Documentation/git-update-ref.txt: remove safety
 paragraphs
Date: Sat, 19 Oct 2024 21:59:19 +0200
Message-ID: 
 <71d1e6364a21767a8d80c96a30282e6557fec426.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: 71d1e6364a21767a8d80c96a30282e6557fec426

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Remove paragraphs which explain that using this command is safer than
echoing the branch name into `HEAD`.

These paragraphs have been part of the documentation since the
documentation was created in 129056370ab (Add missing documentation.,
2005-10-04), back when the command synopsis was a lot simpler:

    `git-update-ref` <ref> <newvalue> [<oldvalue>]

These paragraphs don’t interrupt the flow of the document on that
revision since it is at the end.  Now though it is placed after the
description of `--no-deref` and before `-d` and `--stdin`.  Covering all
the options is more generally interesting than a safety note about a
naïve `HEAD` management.

Such a safety warning is also much less relevant now, considering that
everyone who isn’t intentionally poking at the internal implementation
is using porcelain commands to manage `HEAD`.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 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 fe5967234e9..ec268b1426d 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 it
 still contains <old-oid>.
 

From patchwork Sat Oct 19 19:59:20 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842882
Received: from fout-b7-smtp.messagingengine.com
 (fout-b7-smtp.messagingengine.com [202.12.124.150])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8EE4B188CB5
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:24 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.150
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368026; cv=none;
 b=XoPpzugmsoG2Lj6QLDfBp+PpgLKSYpae0Q7u8PE8pkvMSa3ha9Pi3pobefGYL6zD+Mx6tNkOHovgVNun1hMgMmmiGm8qOG3Do8PPOQWLcXhBivW6Sst1sCEWy97HSJ1Htv0uZjlPsAtucCDwIa9KrbJam3a/CQqhu2eLIMlUP5A=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368026; c=relaxed/simple;
	bh=mQWXbJCo3ZthSAMX1YkIYlCRwPG5xAphUX33efYRg00=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version:Content-Type;
 b=A22mD7p0kjUlm8LLY5uFAEyYbpup/7ExsnOsLs0vIX8isd8ryEn2sGz7nfulA8VAJkLvwS68yudb/xjWeKpqyq9oEMbvp1KvNvG5Tk3429gFWr+oPwsAjLKTZzKrvGi/bZ6weSv1MvKvSzQU0tOlnjySkQ3I/nobni0hQWAN3j4=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=GpfkOuM+;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=l3kF92AT; arc=none smtp.client-ip=202.12.124.150
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="GpfkOuM+";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="l3kF92AT"
Received: from phl-compute-11.internal (phl-compute-11.phl.internal
 [10.202.2.51])
	by mailfout.stl.internal (Postfix) with ESMTP id 8C25D1140092;
	Sat, 19 Oct 2024 16:00:23 -0400 (EDT)
Received: from phl-mailfrontend-01 ([10.202.2.162])
  by phl-compute-11.internal (MEProxy); Sat, 19 Oct 2024 16:00:23 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:content-type:date
	:date:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to; s=fm2; t=1729368023;
	 x=1729454423; bh=8npD8EdiYf6ydygU9OnYqaJXF5OLp1GzMK34kNOvddw=; b=
	GpfkOuM+J+Ej7AP2pVyTMQJCzN22ouvgIndUb90chXiLbe5MZ1jSm1tbwqe4ROK6
	g8BgK389+PgZh+0RVrC+aRS3DDsjKwelzuqNraVJ2M4MEP7Xk6iH3ujXlk011AAJ
	p1396tbeUwJteBqIdYfuFYBN/Zz8Vr5heKz5by+qvl97KDTA3Fp9irHELONJR6aO
	vQFcINKyGSo0cJl8QgMcIQB9OMuzSb3RULiUhc2QQa8O8vup5Plkbapau7tpBucB
	qjfaWFxsu494dMZWNdMJrRTX7o+PLlocNkxxdNi3IigzQY/FMA2+qA7FC5paAwmH
	7UU21eA7VYD0wWbnkw4apA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:content-type:date:date:feedback-id:feedback-id
	:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368023; x=
	1729454423; bh=8npD8EdiYf6ydygU9OnYqaJXF5OLp1GzMK34kNOvddw=; b=l
	3kF92AT2Te3VhDyGLwvwUO299bHnDbIXs081zcFRIhlV1OR67N06d4e3l79zVU9g
	fPf1epxI8PWPlgLkwOnq5Hq8TW2CPDWmawnV+gpyZVL9hfO+BCtQoKxbIpFSp6CR
	nBHdGZBRbprqk/+4Sft+akG2DCChByS4M4DVNYXNVhPq1a7Vmx7r6F1cQGdMNLmg
	u5Vmhtca8nqJKY8zKngUY7cqlJyinTBBsF985oEwnt5SWJHyifypxjg9YVGqULLC
	4diNaOsTPl8F6PA95/DZ1ZBaC5NhdtC4QK6xIlrm7TEyGKLjiO+mFkdNJ9o087v5
	Oz7sVk0Qp65/Qfyebcx/A==
X-ME-Sender: <xms:1w8UZ32btWvC968UpmaRzZ5KOKJN6TcZYyBRZpcw_MAafqLwXOTru_c>
    <xme:1w8UZ2GeNwvcoAEwn8R4ZLFQQNfHDSwJP5gV_zCnpjwnZGN3dfDNdSCGUU7lQL0X7
    0MNSiPtc_gZ7fETuQ>
X-ME-Received: 
 <xmr:1w8UZ37txdXSDNUYi9mvwtHQPDVA2C6f7LBAIy0oXWJJGWvPnMJRtsuImsY6yI3oSaYRNf2IZFgdGXTQjFqypWl6YyhRbCbbajf8BbkQpb7Rtjz6z4AamEwFbw>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegiecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhggtgfgsehtkeertdertdejnecuhfhrohhmpehkrhhishhtohhffhgvrhhh
    rghughhssggrkhhksehfrghsthhmrghilhdrtghomhenucggtffrrghtthgvrhhnpefhgf
    eglefhjeekgfetleetjefhteeiheegfedtudduffegjefhkeetudeggffhkeenucevlhhu
    shhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehkrhhishhtohhffh
    gvrhhhrghughhssggrkhhksehfrghsthhmrghilhdrtghomhdpnhgspghrtghpthhtohep
    kedpmhhouggvpehsmhhtphhouhhtpdhrtghpthhtohepghhithesvhhgvghrrdhkvghrnh
    gvlhdrohhrghdprhgtphhtthhopegtohguvgeskhhhrghughhssggrkhhkrdhnrghmvgdp
    rhgtphhtthhopehphhhilhhlihhprdifohhougesughunhgvlhhmrdhorhhgrdhukhdprh
    gtphhtthhopehgihhtshhtvghrsehpohgsohigrdgtohhmpdhrtghpthhtohepsggvnhgt
    vgesfhgvrhguihhnrghnugihrdgtohhmpdhrtghpthhtohepkhgrrhhthhhikhdrudekke
    esghhmrghilhdrtghomhdprhgtphhtthhopehmvgesthhtrgihlhhorhhrrdgtohhmpdhr
    tghpthhtohepshhunhhshhhinhgvsehsuhhnshhhihhnvggtohdrtghomh
X-ME-Proxy: <xmx:1w8UZ82-sFHFSpwuHJS_R8hwTVdJIvm8Rme3uo5KMdt35jS3Ww-qNw>
    <xmx:1w8UZ6Ev7Xo25lkGN_aWWVXP6vGS4iNu5iKnq4iwDCBAk1meLbsVpA>
    <xmx:1w8UZ9-JGnejkrHyQVXdKDpTMq-3bg1k1T9YiPbQ-iDDHYeN8KNOOg>
    <xmx:1w8UZ3mfXHzon6FoPA-N0-TdscSoFuKEYSoMlFfzSpSCoKWyZHVc8g>
    <xmx:1w8UZ4Yx4-c70jfkCcZXJYUp5ssR7pZHNphhO-6lDAqU59sNeWspmVUC>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:21 -0400 (EDT)
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 v2 3/6] Documentation/git-update-ref.txt: demote symlink to
 last section
Date: Sat, 19 Oct 2024 21:59:20 +0200
Message-ID: 
 <ca786bff9783d671d5e3c36ffa35ade6029eada5.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: ca786bff9783d671d5e3c36ffa35ade6029eada5

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Move the discussion of file system symbolic links to a new “Notes”
section (inspired by the one in git-symbolic-ref(1)) since this is
mostly of historical note at this point, not something that is needed in
the main section of the documentation.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-update-ref.txt | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index ec268b1426d..c03e65404e8 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -29,14 +29,6 @@ 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:".
 
-More importantly, it allows the update of a ref file to follow
-these symbolic pointers, whether they are symlinks or these
-"regular file symbolic refs".  It follows *real* symlinks only
-if they start with "refs/": otherwise it will just try to read
-them and update them as a regular file (i.e. it will allow the
-filesystem to follow them, but will overwrite such a symlink to
-somewhere else with a regular filename).
-
 If --no-deref is given, <ref> itself is overwritten, rather than
 the result of following the symbolic pointers.
 
@@ -185,6 +177,17 @@ An update will fail (without changing <ref>) if the current user is
 unable to create a new log file, append to the existing log file
 or does not have committer information available.
 
+NOTES
+-----
+
+Symbolic refs were initially implemented using symbolic links.  This is
+now deprecated since not all filesystems support symbolic links.
+
+This command follows *real* symlinks only if they start with "refs/":
+otherwise it will just try to read them and update them as a regular
+file (i.e. it will allow the filesystem to follow them, but will
+overwrite such a symlink to somewhere else with a regular filename).
+
 GIT
 ---
 Part of the linkgit:git[1] suite

From patchwork Sat Oct 19 19:59:21 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842883
Received: from fhigh-b3-smtp.messagingengine.com
 (fhigh-b3-smtp.messagingengine.com [202.12.124.154])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id BAE871922D9
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:28 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.154
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368030; cv=none;
 b=GJbe9IFLqJCSSy8EP3t4u3GTBuNjvB63J+iXG5yCrp/ta/mbqjiqv0HtVd/+MX5Wn1R5qZJMsOAnjcjjHmLU1q0Fi78XjM9kLaeQrwgeLjGfJZuUrhtVZnyQk9R1zBCWA4LX9feR1Bq49ymOKQBHxBlnmMTpVp/mAx7/B0msWBo=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368030; c=relaxed/simple;
	bh=CrPBbdyObAwKKRed52XrPZSUew5aoYGYz5S5H5y+hE8=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version:Content-Type;
 b=ByeA4dmcekWktqp8QIPlOx5OlgwsbyCynjV7O+S5Zoh6e547S3nBalq5GRmSC97U8P3y7xfRGnqPirifL20KzyQ3UrcPiprqpsewsaa61I7JhncCRpuopBJlkhfRKknFbosB5iGbI+6iyIgy5F07HrSOq1H9BBGlRDS/tgqyKhE=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=pC6+XzGL;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=PgLGdXqR; arc=none smtp.client-ip=202.12.124.154
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="pC6+XzGL";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="PgLGdXqR"
Received: from phl-compute-01.internal (phl-compute-01.phl.internal
 [10.202.2.41])
	by mailfhigh.stl.internal (Postfix) with ESMTP id 98159254008D;
	Sat, 19 Oct 2024 16:00:27 -0400 (EDT)
Received: from phl-mailfrontend-01 ([10.202.2.162])
  by phl-compute-01.internal (MEProxy); Sat, 19 Oct 2024 16:00:27 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:content-type:date
	:date:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to; s=fm2; t=1729368027;
	 x=1729454427; bh=0aV/4BQF6BTXIVmGBI12bxjAlGPPQrqMqF6P1oS5tK8=; b=
	pC6+XzGLK4QLp95i7E/4LpM7dlsOzTySXpYhhH/lhHWAMWAKsi8RtPu9CKmJxmFj
	7A9aEBk0/7AnMULUgKdwm3CHiXVLh/wCG2S2+MCXjcGwJKr2LPFEXfm702qvbhSc
	vlf50vUmW59DW59P9cvUOA0/4ij5dSMUB0HbxYWjeKcfmQyh2su2rDUnomziESqs
	R1tU5+7p2K4SoV3T7f7/PBUf3EWWVYzHHE6VGhivVXpMzNfEWHyhPeqFl2mQKcAp
	dpY1bM8+81T0+8QV5Dh+X1VNOGwrxDM6bCxxO/ywXUMdnTbxe+pG7mWZHVOPNnLE
	t1Hmd9whhnHdT6NeYDDZIA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:content-type:date:date:feedback-id:feedback-id
	:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368027; x=
	1729454427; bh=0aV/4BQF6BTXIVmGBI12bxjAlGPPQrqMqF6P1oS5tK8=; b=P
	gLGdXqRs98MvN+RhtHZWd7RjGrKEdWogNj8chYtl21gNxE+qvZl8G1CKSmGyoMQ4
	MfVGuh3c9eCag7k9gnBGGTzZzk5yuKbfL4noeuKH+57G2mHQlf6A4rxXs+9pgoY6
	MH+2rYfXRRYjqFOdVbOy7WGHqRaf/Lx5XY63l0X9uge+G/VZB2So0uWKVUhRyUC1
	Kx4/8+5JRb8RUqPh9WqBZ9GGuuBjsevSFgs5BQfytw9gcY5IoWvPZQN70pgU4/H1
	0/D3Q4R3mX/5x1rjNKgplGHtCDRxqPjQ7skWtAs17CDgp+AjexcXKJj7QymXQ/w+
	w6eepFzGuwPVdo020GQlA==
X-ME-Sender: <xms:2w8UZ6wr9MOtu0LOId_co5gvYoag1zOORaBZXw3gsyC7DznfhCiKS5w>
    <xme:2w8UZ2Q8uYDT59h0FeZrdPUxWYT1KTJ3KOpJAwI55HOHzKDhI-75G7OSMJbZd_kKU
    uNZKHQkhSRSBRAYQg>
X-ME-Received: 
 <xmr:2w8UZ8XmsJYDMv30nIVRRdlLCYiHuT0uDo6WbEcW6MNiON2SUGixwFlqHcBAc8FDDaZXPkO7jDJmtChqsOeuzU2FOiKxogBV8Qc8ceM07WvWH05pfnuG8ekmkQ>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegjecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhggtgfgsehtkeertdertdejnecuhfhrohhmpehkrhhishhtohhffhgvrhhh
    rghughhssggrkhhksehfrghsthhmrghilhdrtghomhenucggtffrrghtthgvrhhnpefhgf
    eglefhjeekgfetleetjefhteeiheegfedtudduffegjefhkeetudeggffhkeenucevlhhu
    shhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehkrhhishhtohhffh
    gvrhhhrghughhssggrkhhksehfrghsthhmrghilhdrtghomhdpnhgspghrtghpthhtohep
    kedpmhhouggvpehsmhhtphhouhhtpdhrtghpthhtohepghhithesvhhgvghrrdhkvghrnh
    gvlhdrohhrghdprhgtphhtthhopegtohguvgeskhhhrghughhssggrkhhkrdhnrghmvgdp
    rhgtphhtthhopehphhhilhhlihhprdifohhougesughunhgvlhhmrdhorhhgrdhukhdprh
    gtphhtthhopehgihhtshhtvghrsehpohgsohigrdgtohhmpdhrtghpthhtohepsggvnhgt
    vgesfhgvrhguihhnrghnugihrdgtohhmpdhrtghpthhtohepkhgrrhhthhhikhdrudekke
    esghhmrghilhdrtghomhdprhgtphhtthhopehmvgesthhtrgihlhhorhhrrdgtohhmpdhr
    tghpthhtohepshhunhhshhhinhgvsehsuhhnshhhihhnvggtohdrtghomh
X-ME-Proxy: <xmx:2w8UZwisJvHg8MXToxrMMO14y55suu9-mtkP2nzrZBVsnzjPyhCymg>
    <xmx:2w8UZ8Azqi9HhlFqFEOItxaZ41v1RIkRHqG7A7L8fEmYmjQiHHhHzA>
    <xmx:2w8UZxIl3euXCaZP1wS5S6wk9-3UflJsTIwRR6VosuZ4IinouIArSA>
    <xmx:2w8UZzCGrFenkOU4ebDWyH9pyyWd78TCxtbNpCGS5b9xGvyAZYGeVA>
    <xmx:2w8UZ40Kq02FZFnkhjrywxZ3fgfUVgQZJatpPdF4f_PMWE7Tu07rUNRY>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:25 -0400 (EDT)
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 v2 4/6] Documentation/git-update-ref.txt: remove confusing
 paragraph
Date: Sat, 19 Oct 2024 21:59:21 +0200
Message-ID: 
 <769fd20945dad7ec60f1109525466d916afa97a8.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: 769fd20945dad7ec60f1109525466d916afa97a8

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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 `<new-oid>` 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 <bence@ferdinandy.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v2:
    • Message: replace “this” with “the”, which avoids two “this” close to
      each other
    • Message: Mention that what a symref is (concretely) is covered
      by gitglossary(7)

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

diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index c03e65404e8..4bb3389cc7c 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -25,10 +25,6 @@ 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.
 
-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, <ref> itself is overwritten, rather than
 the result of following the symbolic pointers.
 

From patchwork Sat Oct 19 19:59:22 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842884
Received: from fout-b7-smtp.messagingengine.com
 (fout-b7-smtp.messagingengine.com [202.12.124.150])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 196591917E8
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:32 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.150
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368035; cv=none;
 b=a+oXZ0yQaDRt/dPtH5AeAgKY9qtZti1ZNteblgBfD138OzLGukxrikhOorYAWoIqcI76flg49micX9H8S1Um53f03NXxotjDfLF4/vANHN7RLt53/PnEMiEuhESJ5HTIOJ21lF041U5MBe0Soy991KIGin0Q1aaQ1ae3avEKhGU=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368035; c=relaxed/simple;
	bh=uBt/QdSebGuCEXMGFRSOx4oqk6Mj+tzyTT4GQ+dnfeU=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version:Content-Type;
 b=fCAn3PJGyNh3cbdllE/T+JtUUy2NIPHKiKhUrymRmsUgt00uVCN8KRT+xyVP4TQdxc//gB6yQWiYhv0suV3FyAV87/Qmw+BugCiuiX+wJeAEFpDnMil1e4jpi89jnPleevWpb4zINyy+FdWvsk5d54ka0NglmckwM3TelcXLAjM=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=XmTt5mIy;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=cSiClN0S; arc=none smtp.client-ip=202.12.124.150
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="XmTt5mIy";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="cSiClN0S"
Received: from phl-compute-08.internal (phl-compute-08.phl.internal
 [10.202.2.48])
	by mailfout.stl.internal (Postfix) with ESMTP id 299061140092;
	Sat, 19 Oct 2024 16:00:32 -0400 (EDT)
Received: from phl-mailfrontend-01 ([10.202.2.162])
  by phl-compute-08.internal (MEProxy); Sat, 19 Oct 2024 16:00:32 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:content-type:date
	:date:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to; s=fm2; t=1729368032;
	 x=1729454432; bh=Xei2KAtErhqQBZ8MQRHooWSLLxdUUUf2Z0PKPL3GZJg=; b=
	XmTt5mIyxMi1z5zAxXduHont4jsqa+cZwBG8qXa8tpWVG9D90MS7saY5PcKI31bm
	pAtSUhkCciv23T0FeBuyY1v6ZcRhP9lTlxmNCfglP2VcnUvO1IGShQYMGJXzum4T
	Yys400WQI6OKDGSv6hO9bueHTvJNWI9bH4f8NZ7GSu9dXWR5tKTjDGjbJAJ2qpiK
	f2Nh92Kpwtd0s4lKr41URv6oVj6Ga35zboxTX6lG6O1b6HzIIwBRVHaG1ZbxcC1m
	jZwlXFSpNU9wdCz9EHeY16Q6nKlmmdz2AUKU4GjdQrn/PoqqnTJrA8Ms4ExJRUBE
	qDT1QbZE+RqVCSlx7rGVPg==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:content-type:date:date:feedback-id:feedback-id
	:from:from:in-reply-to:in-reply-to:message-id:mime-version
	:references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368032; x=
	1729454432; bh=Xei2KAtErhqQBZ8MQRHooWSLLxdUUUf2Z0PKPL3GZJg=; b=c
	SiClN0SdRzORQLkMsM3qun1l/KfqpTPzsI8RzRQNxf720QImkkY/sR295XFBSGzf
	qUN0OHyPKc/1RDT05kuco9YN1+EwJm+JccmiybUaE0539zmziUsphJIUvKjB25zL
	O9hdnoYwJAcaYXLozULdpMUE6ZjL76/hP6u6dA/UhnUcs4+WkHyZGtcB5VKyDczw
	QdzDbxpAQpwJVK+iYqOjpnokIyEsMtdCNBNcuMKumAeLTWeDCPKwGnTJoZk0ut8r
	+r0WZl9Y2spZRzBKCV+6QjJE3dtjPphzRmku58GL7U1nvvxXXpeh9vBov2AowPvA
	PQwK4LnRtm2lYpzz6cuQw==
X-ME-Sender: <xms:3w8UZ9M7nbA_3tsXOge5kknJQ3uf8y2hokvvcI0f776ryAEuuvQiWt0>
    <xme:3w8UZ_8mLN_kGJFPg9gP1M5qm7SqXlN_QIStr2lzZ_qMa-BIn1XTnTJI2i4gwcxrH
    qvlKanV9w5jGhfHvQ>
X-ME-Received: 
 <xmr:3w8UZ8QMSr2jnztvBcRCI9GTlYjEApG7g0A2Fjn3lthEG6_8FwHlnLKvvGz0pr7HDQ_c3-XCBL6fBAzVn6_ZDCt9V-I4SHBtrp5pvdhQhrG_uNCL57DmPyBVgQ>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegiecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhggtgfgsehtkeertdertdejnecuhfhrohhmpehkrhhishhtohhffhgvrhhh
    rghughhssggrkhhksehfrghsthhmrghilhdrtghomhenucggtffrrghtthgvrhhnpedule
    fgueeiueetkeelieefgedufeehteekhfejffekvdeuhedtvefhkeeikefhgfenucffohhm
    rghinhepkhgvrhhnvghlrdhorhhgnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrg
    hmpehmrghilhhfrhhomhepkhhrihhsthhofhhfvghrhhgruhhgshgsrghkkhesfhgrshht
    mhgrihhlrdgtohhmpdhnsggprhgtphhtthhopeekpdhmohguvgepshhmthhpohhuthdprh
    gtphhtthhopehgihhtsehvghgvrhdrkhgvrhhnvghlrdhorhhgpdhrtghpthhtoheptgho
    uggvsehkhhgruhhgshgsrghkkhdrnhgrmhgvpdhrtghpthhtohepphhhihhllhhiphdrfi
    hoohguseguuhhnvghlmhdrohhrghdruhhkpdhrtghpthhtohepghhithhsthgvrhesphho
    sghogidrtghomhdprhgtphhtthhopegsvghntggvsehfvghrughinhgrnhguhidrtghomh
    dprhgtphhtthhopehkrghrthhhihhkrddukeeksehgmhgrihhlrdgtohhmpdhrtghpthht
    ohepmhgvsehtthgrhihlohhrrhdrtghomhdprhgtphhtthhopehsuhhnshhhihhnvgessh
    hunhhshhhinhgvtghordgtohhm
X-ME-Proxy: <xmx:3w8UZ5vzkiHb6gkA5CDqUgJu04VanXrWrCKH9mLvDwHL4jkw5j7MOA>
    <xmx:3w8UZ1e_lovGvviMwzpJ2tOjvBGzqC3oVMmY8rb8ONxt7yKvBwUKwQ>
    <xmx:3w8UZ10-MjZoLiEceac_uBoYmH0NTLw44pXKeTgUmen3Pv8kBxORyw>
    <xmx:3w8UZx-txc1PNJ00BMrOPecW3Q738MRzeFufV64AL3eGpVeOtFnnpw>
    <xmx:3w8UZ0yuZSTRYTbhgQuiUg6tAUeRf2DGDu6rnbtweEupgAOhBoUYfvqg>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:29 -0400 (EDT)
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 v2 5/6] Documentation/git-update-ref.txt: discuss symbolic
 refs
Date: Sat, 19 Oct 2024 21:59:22 +0200
Message-ID: 
 <ca5ece5336c85a47339537577a4c9131f8938cdc.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: ca5ece5336c85a47339537577a4c9131f8938cdc

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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

Notes (series):
    v2:
    • Message: grammar: “robust against”
    • Message: Apparently the first paragraph wasn’t wrapped properly
    • Fix “the the”
    • Credit Bence for this suggestion which I forgot to do in v1
    
      Link: https://lore.kernel.org/git/D4U30MD29CJT.3US5SBR598DVY@ferdinandy.com/
    • Message: “symbolic refs”, not links

 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..5866b6f2d37 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.
 

From patchwork Sat Oct 19 19:59:23 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
X-Patchwork-Id: 13842885
Received: from fhigh-b3-smtp.messagingengine.com
 (fhigh-b3-smtp.messagingengine.com [202.12.124.154])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id CEFD61922F3
	for <git@vger.kernel.org>; Sat, 19 Oct 2024 20:00:36 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
 arc=none smtp.client-ip=202.12.124.154
ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1729368038; cv=none;
 b=CvJQonlrgHS/aQEPFzvgW0pOCrQqKKMmV3NLJDicgw7932cShjiDIs/CIqjZZQbyeBslALdYF2OvQHe+JwTs3D0q8duH3biJe+OiORkahI8r3IcA94Ooj2ZRsc8KSOPNdw3NZmSYV2U5BstgCuZxUrmJJvGc020inCSkLVWkGEs=
ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1729368038; c=relaxed/simple;
	bh=9r7SumsvYpExKTdHHP0hHDaJPD/KDwbWT11nP+8KHrE=;
	h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References:
	 MIME-Version;
 b=Ke4I2SliyTpByfGMZwtwGkzsAj4+WojkueCsebj8VhPU1LFyH+3ibYUC1lkVlkXb+3uR3cAEuT5uScEyDrIXemkKFj+ycMHH/LE31a72sqp1JwFChEjU+kZ8WTWLzGTcEcwe38HWmbNjxuo5BlnRvjlgakTdnnC06MWPdW2e9GQ=
ARC-Authentication-Results: i=1; smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com;
 spf=pass smtp.mailfrom=fastmail.com;
 dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b=F9PiRR4y;
 dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com
 header.b=HccAU8QB; arc=none smtp.client-ip=202.12.124.154
Authentication-Results: smtp.subspace.kernel.org;
 dmarc=pass (p=none dis=none) header.from=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
 spf=pass smtp.mailfrom=fastmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=fastmail.com header.i=@fastmail.com
 header.b="F9PiRR4y";
	dkim=pass (2048-bit key) header.d=messagingengine.com
 header.i=@messagingengine.com header.b="HccAU8QB"
Received: from phl-compute-11.internal (phl-compute-11.phl.internal
 [10.202.2.51])
	by mailfhigh.stl.internal (Postfix) with ESMTP id C64AE2540078;
	Sat, 19 Oct 2024 16:00:35 -0400 (EDT)
Received: from phl-mailfrontend-02 ([10.202.2.163])
  by phl-compute-11.internal (MEProxy); Sat, 19 Oct 2024 16:00:36 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h=
	cc:cc:content-transfer-encoding:content-type:date:date:from:from
	:in-reply-to:in-reply-to:message-id:mime-version:references
	:reply-to:subject:subject:to:to; s=fm2; t=1729368035; x=
	1729454435; bh=hwKc7CnlziamuVIz7+hPUMiHzDp8SH1qQU0MPNOSzJs=; b=F
	9PiRR4ySSLidQPF2i3vL1+Kt/FV/tc8dqdu0nYUWb7aF455AQvDz5Jajo4DdZ/A3
	oDm/58B/LL6qpdZGP4XaWjvEHMIMiTV1c6LAKcGOcd6ja5WNpwYe1heqDOgRSrT8
	uooBcXMfsBYgf9KaDYGFiVxDBbjvPRea1l9bcE6CJ2Z3jH9Z8mwJk+6P540EvI2D
	GvTprbjb/0rAUIWjMl1527Q/L6pRyc4/TrXYWhLHo0si0swN8VEVyBEcOu+BD4cJ
	m9IuvZVzUL7LJFBMTo6TThl2Q33CRuMxbQoSS2qYbI5Z0jxr/4YoLz3YqDc7YbRC
	Pk9VIk2/7Da07RaZ/Souw==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
	messagingengine.com; h=cc:cc:content-transfer-encoding
	:content-type:date:date:feedback-id:feedback-id:from:from
	:in-reply-to:in-reply-to:message-id:mime-version:references
	:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy
	:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1729368035; x=
	1729454435; bh=hwKc7CnlziamuVIz7+hPUMiHzDp8SH1qQU0MPNOSzJs=; b=H
	ccAU8QBhl4lAYQHYBDXaUDRWKxYxnd67d9/aRWNHWvkcx9bsBIP2aAxSTqvbUibX
	mUt3dF/i4tyGPc0pNT3Db8Tps4KTGHR0VsF1bRNQZvzEwOBEPtqhtPgo6LRPZTCl
	hblDY+HK0sJ4QHQp/It/ZrXeY2GjKDGQ56D/g/+BwS4CR+t4neRjhNXxyqlaVcV6
	RsLh/Y2qH8zXtI29hisjKJFhHd3UK1PJAQyPWd2OFbikottIMTrlVzCyVIYYhB3B
	qNsVsZ2z7n1zQRvpxs/JiuQNjgXe+Ndis/S/iUWJE6QOpiqDzR3DK7jdDTKUPAFX
	xV4U8HkLzvEL87l4ExUZg==
X-ME-Sender: <xms:4w8UZ8xgJWnNK0R4rrPOFpoVXPcV2y3jv1Dv-j6iNze6PNOAvD05IxM>
    <xme:4w8UZwSb58WuZLSpVDUj3dpraDGKOUMzcjLHuLOLn3lEoJjD2RPYBo6A545BhveTl
    d9M8SsmlS-jP6rBqg>
X-ME-Received: 
 <xmr:4w8UZ-Xw8q-i_y40fRF0EbzboL4PNGnrLn0vfBWQgvpalhwpSGVs1fiTgkhyOEF53AdypREgLs_16UHx6n2Sfdhu73jWS4fNQSo4XHH6zY1STBS7NQ933qtxaQ>
X-ME-Proxy-Cause: 
 gggruggvucftvghtrhhoucdtuddrgeeftddrvdehhedgudegiecutefuodetggdotefrod
    ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp
    uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvve
    fufffkofgjfhgggfestdekredtredttdenucfhrhhomhepkhhrihhsthhofhhfvghrhhgr
    uhhgshgsrghkkhesfhgrshhtmhgrihhlrdgtohhmnecuggftrfgrthhtvghrnhepfeehte
    ekfedtieffvdejteeutefhuefgtefgtdevhefhveffuefftdehiedtfedunecuvehluhhs
    thgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepkhhrihhsthhofhhfvg
    hrhhgruhhgshgsrghkkhesfhgrshhtmhgrihhlrdgtohhmpdhnsggprhgtphhtthhopeek
    pdhmohguvgepshhmthhpohhuthdprhgtphhtthhopehgihhtsehvghgvrhdrkhgvrhhnvg
    hlrdhorhhgpdhrtghpthhtoheptghouggvsehkhhgruhhgshgsrghkkhdrnhgrmhgvpdhr
    tghpthhtohepphhhihhllhhiphdrfihoohguseguuhhnvghlmhdrohhrghdruhhkpdhrtg
    hpthhtohepghhithhsthgvrhesphhosghogidrtghomhdprhgtphhtthhopegsvghntggv
    sehfvghrughinhgrnhguhidrtghomhdprhgtphhtthhopehkrghrthhhihhkrddukeekse
    hgmhgrihhlrdgtohhmpdhrtghpthhtohepmhgvsehtthgrhihlohhrrhdrtghomhdprhgt
    phhtthhopehsuhhnshhhihhnvgesshhunhhshhhinhgvtghordgtohhm
X-ME-Proxy: <xmx:4w8UZ6i73RzJgE6zvWcbMCGhlLikc9YVrrqLbSS_C_vKibsX83frhg>
    <xmx:4w8UZ-CaJWyxkO-FGpfaWhapmjDta29h3CjtFgUKdQjm0Jta2bwbMw>
    <xmx:4w8UZ7LNjlxza_4Cozq3_AmtgkCK7FDlC7NyfRsxuZpDYsz8ABAaWg>
    <xmx:4w8UZ1ASUSQd4H4ZxREsp7tdMeM4Xw8ye9dEjq8h0QECQ-qQUCmqxA>
    <xmx:4w8UZ63cA9JEmSRFZDHFQP9C2KerMXcUyzVpE08Iqd15ZGHuz-7Qzvjf>
Feedback-ID: i8b11424c:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat,
 19 Oct 2024 16:00:34 -0400 (EDT)
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 v2 6/6] Documentation: mutually link update-ref and
 symbolic-ref
Date: Sat, 19 Oct 2024 21:59:23 +0200
Message-ID: 
 <fd3c7585a0f84b26debcc216b86dc09acb219799.1729367469.git.code@khaugsbakk.name>
X-Mailer: git-send-email 2.46.1.641.g54e7913fcb6
In-Reply-To: <cover.1729367469.git.code@khaugsbakk.name>
References: <cover.1729017728.git.code@khaugsbakk.name>
 <cover.1729367469.git.code@khaugsbakk.name>
Precedence: bulk
X-Mailing-List: git@vger.kernel.org
List-Id: <git.vger.kernel.org>
List-Subscribe: <mailto:git+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:git+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Commit-Hash: fd3c7585a0f84b26debcc216b86dc09acb219799
X-Previous-Commits: 9e775a65eb3ff49ded231aeeeddd59ccdce3c8a8

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

These two commands are similar enough to acknowledge each other on their
documentation pages.

See the previous commit where we discussed that option-less update-ref
does not support updating symbolic refs but symbolic-ref does.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-symbolic-ref.txt | 4 ++++
 Documentation/git-update-ref.txt   | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 761b154bcbb..33ca381fde0 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -73,6 +73,10 @@ default.
 symbolic ref were printed correctly, with status 1 if the requested
 name is not a symbolic ref, or 128 if another error occurs.
 
+SEE ALSO
+--------
+linkgit:git-update-ref[1]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 5866b6f2d37..c64d80f5a2d 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -190,6 +190,10 @@ otherwise it will just try to read them and update them as a regular
 file (i.e. it will allow the filesystem to follow them, but will
 overwrite such a symlink to somewhere else with a regular filename).
 
+SEE ALSO
+--------
+linkgit:git-symbolic-ref[1]
+
 GIT
 ---
 Part of the linkgit:git[1] suite