git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc: fix `update-ref` `symref-create` formatting

From
Patrick Steinhardt <ps@pks.im>
Date
Dec 9, 2025, 07:23 UTC
Message-ID
<aTfOXDi4Ku0nGVnF@pks.im>
In-Reply-To
<pull.2123.git.git.1765261419802.gitgitgadget@gmail.com>
On Tue, Dec 09, 2025 at 06:23:39AM +0000, Sam Bostock via GitGitGadget wrote:
Show 29 quoted lines
> 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.
This is an obvious fix indeed. Thanks, this looks good to me!
Patrick
Previous: Sam Bostock via GitGitGadgetNext: Junio C Hamano
Message 2 of 3 in “doc: fix `update-ref` `symref-create` formatting”
  1. doc: fix `update-ref` `symref-create` formattingSam Bostock via GitGitGadget, Dec 9, 2025
  2. Patrick SteinhardtDec 9, 2025
  3. Junio C HamanoDec 9, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.