git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH 3/6] git-check-ref-format.txt: avoid single quote
Date: Thu, 13 May 2021 20:17:42 +0200	[thread overview]
Message-ID: <f2a78267fd0f424c5cfa6969c891597af4d5171f.1620928059.git.martin.agren@gmail.com> (raw)
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


  parent reply	other threads:[~2021-05-13 18:18 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-13 18:17 [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Martin Ågren
2021-05-13 18:17 ` [PATCH 1/6] git-http-push.txt,git-send-pack.txt: avoid single quote Martin Ågren
2021-05-13 18:17 ` [PATCH 2/6] git-range-diff.txt: avoid single quotes Martin Ågren
2021-05-13 18:17 ` Martin Ågren [this message]
2021-05-13 19:16   ` [PATCH 3/6] git-check-ref-format.txt: avoid single quote Eric Sunshine
2021-05-13 19:35     ` Martin Ågren
2021-05-13 22:00   ` Junio C Hamano
2021-05-14  9:07     ` Martin Ågren
2021-05-14 12:30       ` Felipe Contreras
2021-05-14  5:30   ` Jeff King
2021-05-14  9:08     ` Martin Ågren
2021-05-13 18:17 ` [PATCH 4/6] diff-options.txt: move monospace markup out of attribute Martin Ågren
2021-05-13 18:17 ` [PATCH 5/6] git-svn.txt: change verse to listing block Martin Ågren
2021-05-13 18:17 ` [PATCH 6/6] Doc: use two backticks for monospace, not backtick+apostrophe Martin Ågren
2021-05-13 20:35 ` [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Junio C Hamano
2021-05-14  8:40   ` Martin Ågren
2021-05-14 12:18     ` Felipe Contreras
2021-05-14  1:40 ` Felipe Contreras
2021-05-14  8:43   ` Martin Ågren
2021-05-14 12:24     ` Felipe Contreras
2021-05-14 15:28       ` Martin Ågren
2021-05-14 20:11         ` Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f2a78267fd0f424c5cfa6969c891597af4d5171f.1620928059.git.martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).