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

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 9, 2025, 22:18 UTC
Message-ID: <xmqqbjk7jo3u.fsf@gitster.g>
In-Reply-To: <aTfOXDi4Ku0nGVnF@pks.im>

Patrick Steinhardt <ps@pks.im> writes:

Show 34 quoted lines

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