]> git.ipfire.org Git - thirdparty/git.git/commitdiff
show-ref doc: fix carets in monospace
authorMartin Ågren <martin.agren@gmail.com>
Wed, 16 Aug 2023 14:24:35 +0000 (16:24 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 16 Aug 2023 18:40:10 +0000 (11:40 -0700)
When commit 00bf685975 (show-ref doc: update for internal consistency,
2023-05-19) switched from double quotes to backticks around our {caret}
macro, we started rendering "{caret}" literally. Fix this by replacing
by a "^" character.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-show-ref.txt

index 44c7387d78f0845f4732665d8dad88e74a6d7c9b..2fe274b8faa6d304bb27a7bc2bb9b09810a94217 100644 (file)
@@ -47,7 +47,7 @@ OPTIONS
 -d::
 --dereference::
 
-       Dereference tags into object IDs as well. They will be shown with `{caret}{}`
+       Dereference tags into object IDs as well. They will be shown with `^{}`
        appended.
 
 -s::
@@ -78,7 +78,7 @@ OPTIONS
        Make `git show-ref` act as a filter that reads refs from stdin of the
        form `^(?:<anything>\s)?<refname>(?:\^{})?$`
        and performs the following actions on each:
-       (1) strip `{caret}{}` at the end of line if any;
+       (1) strip `^{}` at the end of line if any;
        (2) ignore if pattern is provided and does not head-match refname;
        (3) warn if refname is not a well-formed refname and skip;
        (4) ignore if refname is a ref that exists in the local repository;