-
Notifications
You must be signed in to change notification settings - Fork 27.2k
doc: fix update-ref symref-create formatting
#2123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
There are issues in commit 87cab95: |
`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]>
|
/preview |
|
Preview email sent as [email protected] |
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
|
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 |
|
User |
|
This patch series was integrated into seen via d92ee23. |
|
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. |
|
This branch is now known as |
|
This patch series was integrated into seen via 0601608. |
|
This patch series was integrated into seen via 78111dc. |
|
This patch series was integrated into seen via f638dba. |
|
This patch series was integrated into seen via 94802ae. |
|
There was a status update in the "Cooking" section about the branch Doc mark-up fix. Will merget to 'next'. source: <[email protected]> |
|
This patch series was integrated into seen via 38c2de5. |
|
This patch series was integrated into seen via 76e0825. |
|
This patch series was integrated into seen via b95dae1. |
|
There was a status update in the "Cooking" section about the branch Doc mark-up fix. Will merget to 'next'. source: <[email protected]> |
|
This patch series was integrated into seen via 66e0bae. |
|
This patch series was integrated into seen via 680af0e. |
|
This patch series was integrated into seen via e86aa3e. |
|
This patch series was integrated into seen via 0ad1697. |
|
There was a status update in the "Cooking" section about the branch Doc mark-up fix. Will merget to 'next'. source: <[email protected]> |
|
There was a status update in the "Cooking" section about the branch Doc mark-up fix. Will merget to 'next'. source: <[email protected]> |
cc: Patrick Steinhardt [email protected]