git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 3/4] show-ref doc: fix carets in monospace

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Aug 16, 2023, 14:24 UTC
Message-ID
<f52247af9027192d0a29b8ee049db20250314d74.1692194193.git.martin.agren@gmail.com>
In-Reply-To
<cover.1692194193.git.martin.agren@gmail.com>

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>
---
 Documentation/git-show-ref.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 44c7387d78..2fe274b8fa 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -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;
-- 
2.42.0.rc2.215.g538df5cf27
Previous: Martin ÅgrenNext: Junio C Hamano
Message 11 of 12 in “some doc fixes on v2.42.0-rc2”
  1. 0/4 some doc fixes on v2.42.0-rc2Martin Ågren, Aug 16, 2023
  2. 1/4 notes doc: split up run-on sentencesMartin Ågren, Aug 16, 2023
  3. 1/4 notes doc: split up run-on sentencesTeng Long, Aug 17, 2023
  4. 4/4 rev-list-options: fix typo in `--stdin` documentationMartin Ågren, Aug 16, 2023
  5. Junio C HamanoAug 16, 2023
  6. Junio C HamanoAug 16, 2023
  7. Martin ÅgrenAug 17, 2023
  8. 2/4 notes doc: tidy up `--no-stripspace` paragraphMartin Ågren, Aug 16, 2023
  9. 2/4 notes doc: tidy up `--no-stripspace` paragraphTeng Long, Aug 17, 2023
  10. Martin ÅgrenAug 17, 2023
  11. 3/4 show-ref doc: fix carets in monospaceMartin Ågren, Aug 16, 2023
  12. Junio C HamanoAug 16, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.