kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

show-ref doc: fix carets in monospace 

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>
maint
Martin Ågren 2023-08-16 16:24:35 +02:00 committed by Junio C Hamano
parent 51f9d2e563
commit 18c4aac0dd
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-show-ref.txt
View File

@ -47,7 +47,7 @@ OPTIONS
-d:: -d::
--dereference:: --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. appended.


-s:: -s::
@ -78,7 +78,7 @@ OPTIONS
Make `git show-ref` act as a filter that reads refs from stdin of the Make `git show-ref` act as a filter that reads refs from stdin of the
form `^(?:<anything>\s)?<refname>(?:\^{})?$` form `^(?:<anything>\s)?<refname>(?:\^{})?$`
and performs the following actions on each: 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; (2) ignore if pattern is provided and does not head-match refname;
(3) warn if refname is not a well-formed refname and skip; (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; (4) ignore if refname is a ref that exists in the local repository;