doc: fix `update-ref` `symref-create` formatting
PATCH 1/1 doc: fix `update-ref` `symref-create` formatting
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.
---
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(-)
Documentation/git-update-ref.adoc +1 -1
@@ -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
Signature · 1 line
gitgitgadget
Quoted 22 lines · Sam Bostock via GitGitGadget
From: Sam Bostock <[email protected]>
symref-createshould 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 formattingPublished-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/2123Documentation/git-update-ref.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/git-update-ref.adoc +0
-0
Documentation/git-update-ref.adoc verify:: · line 124
Quoted 7 lines
Documentation/git-update-ref.adoc +1
-1@@ -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
Quoted 26 lines · Patrick Steinhardt
Quoted 25 lines · Sam Bostock via GitGitGadget
From: Sam Bostock <[email protected]>
symref-createshould 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 formattingPublished-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/2123Documentation/git-update-ref.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/git-update-ref.adoc +0
-0@@ -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.
Quoted 8 lines
Documentation/git-update-ref.adoc verify:: · line 124
Quoted 4 lines
Documentation/git-update-ref.adoc +1
-1-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.