* [PATCH] doc: fix `update-ref` `symref-create` formatting
@ 2025-12-09 6:23 Sam Bostock via GitGitGadget
2025-12-09 7:23 ` Patrick Steinhardt
0 siblings, 1 reply; 3+ messages in thread
From: Sam Bostock via GitGitGadget @ 2025-12-09 6:23 UTC (permalink / raw)
To: git; +Cc: Sam Bostock, Sam Bostock
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] doc: fix `update-ref` `symref-create` formatting
2025-12-09 6:23 [PATCH] doc: fix `update-ref` `symref-create` formatting Sam Bostock via GitGitGadget
@ 2025-12-09 7:23 ` Patrick Steinhardt
2025-12-09 22:18 ` Junio C Hamano
0 siblings, 1 reply; 3+ messages in thread
From: Patrick Steinhardt @ 2025-12-09 7:23 UTC (permalink / raw)
To: Sam Bostock via GitGitGadget; +Cc: git, Sam Bostock
On Tue, Dec 09, 2025 at 06:23:39AM +0000, Sam Bostock via GitGitGadget wrote:
> 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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] doc: fix `update-ref` `symref-create` formatting
2025-12-09 7:23 ` Patrick Steinhardt
@ 2025-12-09 22:18 ` Junio C Hamano
0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2025-12-09 22:18 UTC (permalink / raw)
To: Patrick Steinhardt; +Cc: Sam Bostock via GitGitGadget, git, Sam Bostock
Patrick Steinhardt <ps@pks.im> writes:
> On Tue, Dec 09, 2025 at 06:23:39AM +0000, Sam Bostock via GitGitGadget wrote:
>> 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
Thanks, both. Queued.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-12-09 22:18 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-12-09 6:23 [PATCH] doc: fix `update-ref` `symref-create` formatting Sam Bostock via GitGitGadget
2025-12-09 7:23 ` Patrick Steinhardt
2025-12-09 22:18 ` Junio C Hamano
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).