From: "Sam Bostock via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Sam Bostock <sam@sambostock.ca>, Sam Bostock <sam@sambostock.ca>
Subject: [PATCH] doc: fix `update-ref` `symref-create` formatting
Date: Tue, 09 Dec 2025 06:23:39 +0000 [thread overview]
Message-ID: <pull.2123.git.git.1765261419802.gitgitgadget@gmail.com> (raw)
From: Sam Bostock <sam@sambostock.ca>
`symref-create` should be followed `::`, not `:`. The lack of second
colon (`:`) causes it to appear as regular text (`<p>`) instead of as a
description list term (`<dt>`) in the HTML documentation.
Signed-off-by: Sam Bostock <sam@sambostock.ca>
---
doc: fix update-ref symref-create formatting
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2123%2Fsambostock%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2123/sambostock/patch-1-v1
Pull-Request: https://github.com/git/git/pull/2123
Documentation/git-update-ref.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-update-ref.adoc b/Documentation/git-update-ref.adoc
index 9310ce9768..37a5019a8b 100644
--- a/Documentation/git-update-ref.adoc
+++ b/Documentation/git-update-ref.adoc
@@ -119,7 +119,7 @@ verify::
Verify <ref> against <old-oid> but do not change it. If
<old-oid> is zero or missing, the ref must not exist.
-symref-create:
+symref-create::
Create symbolic ref <ref> with <new-target> after verifying that
it does not exist.
base-commit: bdc5341ff65278a3cc80b2e8a02a2f02aa1fac06
--
gitgitgadget
next reply other threads:[~2025-12-09 6:23 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-09 6:23 Sam Bostock via GitGitGadget [this message]
2025-12-09 7:23 ` [PATCH] doc: fix `update-ref` `symref-create` formatting Patrick Steinhardt
2025-12-09 22:18 ` Junio C Hamano
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=pull.2123.git.git.1765261419802.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=sam@sambostock.ca \
/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).