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

[PATCH 3/6] git-check-ref-format.txt: avoid single quote

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
May 13, 2021, 18:17 UTC
Message-ID
<f2a78267fd0f424c5cfa6969c891597af4d5171f.1620928059.git.martin.agren@gmail.com>
In-Reply-To
<cover.1620928059.git.martin.agren@gmail.com>

Asciidoctor renders 'git cat-file' with the single quotes. It's somehow tricked by the single quote in "srcref\'s" earler in the paragraph. If we drop the backslash, we'll regress with AsciiDoc. Let's just rewrite things a bit to avoid "srcref's" entirely.

Add backticks for monospacing around these refs and command invocations while at it.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-check-ref-format.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index ee6a4144fb..71d53ffb60 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -70,10 +70,10 @@ reference name expressions (see linkgit:gitrevisions[7]):
 . A tilde `~` and caret `^` are used to introduce the postfix
   'nth parent' and 'peel onion' operation.
 
-. A colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
-  value and store it in dstref" in fetch and push operations.
+. A colon `:` is used as in `srcref:dstref` to mean "use the value
+  of `srcref` and store it in `dstref`" in fetch and push operations.
   It may also be used to select a specific object such as with
-  'git cat-file': "git cat-file blob v1.3.3:refs.c".
+  'git cat-file': `git cat-file blob v1.3.3:refs.c`.
 
 . at-open-brace `@{` is used as a notation to access a reflog entry.
 
-- 
2.31.1.751.gd2f1c929bd
Previous: Martin ÅgrenNext: Eric Sunshine
Message 4 of 22 in “AsciiDoc vs Asciidoctor, once again”
  1. 0/6 AsciiDoc vs Asciidoctor, once againMartin Ågren, May 13, 2021
  2. 1/6 git-http-push.txt,git-send-pack.txt: avoid single quoteMartin Ågren, May 13, 2021
  3. 2/6 git-range-diff.txt: avoid single quotesMartin Ågren, May 13, 2021
  4. 3/6 git-check-ref-format.txt: avoid single quoteMartin Ågren, May 13, 2021
  5. Eric SunshineMay 13, 2021
  6. Martin ÅgrenMay 13, 2021
  7. Junio C HamanoMay 13, 2021
  8. Martin ÅgrenMay 14, 2021
  9. Felipe ContrerasMay 14, 2021
  10. Jeff KingMay 14, 2021
  11. Martin ÅgrenMay 14, 2021
  12. 4/6 diff-options.txt: move monospace markup out of attributeMartin Ågren, May 13, 2021
  13. 5/6 git-svn.txt: change verse to listing blockMartin Ågren, May 13, 2021
  14. 6/6 Doc: use two backticks for monospace, not backtick+apostropheMartin Ågren, May 13, 2021
  15. Junio C HamanoMay 13, 2021
  16. Martin ÅgrenMay 14, 2021
  17. Felipe ContrerasMay 14, 2021
  18. Felipe ContrerasMay 14, 2021
  19. Martin ÅgrenMay 14, 2021
  20. Felipe ContrerasMay 14, 2021
  21. Martin ÅgrenMay 14, 2021
  22. Felipe ContrerasMay 14, 2021

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.