From: "Martin Ågren" <email@example.com>
To: Junio C Hamano <firstname.lastname@example.org>
Cc: Git Mailing List <email@example.com>
Subject: Re: [PATCH 3/6] git-check-ref-format.txt: avoid single quote
Date: Fri, 14 May 2021 11:07:11 +0200 [thread overview]
Message-ID: <CAN0heSqsrUU=GYsckhZT7Dvx=Rh3aWMMTMBLBfy2XuDWYpQPFg@mail.gmail.com> (raw)
On Fri, 14 May 2021 at 00:00, Junio C Hamano <firstname.lastname@example.org> wrote:
> Martin Ågren <email@example.com> writes:
> > Asciidoctor renders 'git cat-file' with the single quotes.
> I somehow find this sentence a bit hard to grok. Do you mean
> "instead of typesetting them emphasized, the two-word phrase is
> enclosed in a pair of literal single quotes"?
Yes. I will improve the description.
> I have no problem with this particular rephrasing from "srcref's
> value" to "value of srcref", but forbidding possessive "'s" from any
> future documentation is troubling.
I think this is a case of several things going on in one paragraph in a
way that confuses the tool. As Felipe commented, it's probably correct
to call it out as an Asciidoctor bug. If we hit is *once* across all our
documentation, I think it's correct to work around it [and report the
bug, if we can], but not let the experience impose a blanket rule on
ourselves that we mustn't do anything that even resembles this
> > -. 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`.
> The proposed log message did not explain why you wanted to avoid
> double-quote pair on the "cat-file" line. Is this meant as a
> workaround for the "single quotes are shown around git cat-file"
Hmm, I've somehow tended to think that it's 'git foo' the tool and `git
foo --bar baz` the actual invocation. SQs for the former, backticks for
the latter. Like, `git cat-file` is not a correct invocation of 'git
cat-file'. But I think I'm starting to see the error in my ways --
CodingGuidelines says to use backticks around command names, so it
really should be `git cat-file`. And changing that might just happen to
avoid the issue that triggered this patch.
Thanks for your comments.
next prev parent reply other threads:[~2021-05-14 9:07 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 ` [PATCH 3/6] git-check-ref-format.txt: avoid single quote Martin Ågren
2021-05-13 19:16 ` Eric Sunshine
2021-05-13 19:35 ` Martin Ågren
2021-05-13 22:00 ` Junio C Hamano
2021-05-14 9:07 ` Martin Ågren [this message]
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
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:
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 \
* 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
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).