Skip to content

Conversation

@sambostock
Copy link

@sambostock sambostock commented Dec 9, 2025

cc: Patrick Steinhardt [email protected]

@gitgitgadget-git
Copy link

There are issues in commit 87cab95:
doc: fix update-ref symref-create formatting
Commit not signed off
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

`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 <[email protected]>
@sambostock
Copy link
Author

/preview

@gitgitgadget-git
Copy link

Preview email sent as [email protected]

@sambostock
Copy link
Author

/submit

@gitgitgadget-git
Copy link

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2123/sambostock/patch-1-v1

To fetch this version to local tag pr-git-2123/sambostock/patch-1-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2123/sambostock/patch-1-v1

@gitgitgadget-git
Copy link

On the Git mailing list, Patrick Steinhardt wrote (reply to this):

On Tue, Dec 09, 2025 at 06:23:39AM +0000, Sam Bostock via GitGitGadget wrote:
> From: Sam Bostock <[email protected]>
> 
> `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 <[email protected]>
> ---
>     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

@gitgitgadget-git
Copy link

User Patrick Steinhardt <[email protected]> has been added to the cc: list.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via d92ee23.

@gitgitgadget-git gitgitgadget-git bot added the seen label Dec 9, 2025
@gitgitgadget-git
Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

Patrick Steinhardt <[email protected]> writes:

> On Tue, Dec 09, 2025 at 06:23:39AM +0000, Sam Bostock via GitGitGadget wrote:
>> From: Sam Bostock <[email protected]>
>> 
>> `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 <[email protected]>
>> ---
>>     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.

@gitgitgadget-git
Copy link

This branch is now known as sb/doc-update-ref-markup-fix.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 0601608.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 78111dc.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via f638dba.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 94802ae.

@gitgitgadget-git
Copy link

There was a status update in the "Cooking" section about the branch sb/doc-update-ref-markup-fix on the Git mailing list:

Doc mark-up fix.

Will merget to 'next'.
source: <[email protected]>

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 38c2de5.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 76e0825.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via b95dae1.

@gitgitgadget-git
Copy link

There was a status update in the "Cooking" section about the branch sb/doc-update-ref-markup-fix on the Git mailing list:

Doc mark-up fix.

Will merget to 'next'.
source: <[email protected]>

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 66e0bae.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 680af0e.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via e86aa3e.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 0ad1697.

@gitgitgadget-git
Copy link

There was a status update in the "Cooking" section about the branch sb/doc-update-ref-markup-fix on the Git mailing list:

Doc mark-up fix.

Will merget to 'next'.
source: <[email protected]>

@gitgitgadget-git
Copy link

There was a status update in the "Cooking" section about the branch sb/doc-update-ref-markup-fix on the Git mailing list:

Doc mark-up fix.

Will merget to 'next'.
source: <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant