From: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
To: Jeff King <peff@peff.net>
Cc: gitster@pobox.com, git@vger.kernel.org,
Jordan DE GEA <jordan.de-gea@ensimag.grenoble-inp.fr>,
Samuel GROOT <samuel.groot@ensimag.grenoble-inp.fr>,
Erwan MATHONIERE <erwan.mathoniere@ensimag.grenoble-inp.fr>,
Tom RUSSELLO <tom.russello@ensimag.grenoble-inp.fr>
Subject: Re: [PATCH 3/6] doc: typeset -- as litteral
Date: Tue, 28 Jun 2016 10:26:58 +0200 [thread overview]
Message-ID: <vpqa8i5zpkd.fsf@anie.imag.fr> (raw)
In-Reply-To: <20160627191005.GD9594@sigill.intra.peff.net> (Jeff King's message of "Mon, 27 Jun 2016 15:10:05 -0400")
Jeff King <peff@peff.net> writes:
> On Mon, Jun 27, 2016 at 07:46:20PM +0200, Matthieu Moy wrote:
>
>> Subject: Re: [PATCH 3/6] doc: typeset -- as litteral
>
> s/litteral/literal/
>
> I can hardly blame you, though. I think English stole the word from
> French and then switched its spelling. :)
I never remember about double consonent, and indeed the fact that French
and English have different spelling for the same words doesn't help
(addition Vs adition, traffic Vs trafic, ...) ;-).
Fixed in v2.
> You may also want put quotes around "--" to make it clear that you are
> talking about it as punctuation, not using it as such in your
> sentence.
Done.
> I read all the way through patch 6, and they all look good to me (though
> the "litteral" typo appears again later). I won't bother responding to
> each separately.
Should all be fixed now.
> I do notice that your patterns are finding existing items marked with
> single-quotes. We may have other cases lurking that are not quoted at
> all (but should be).
Yes, this series (and tr/doc-tt) clearly catch just the low-hanging
fruits. Having forward quotes in the existing text makes it clear that
the author wanted some kind of formatting, and hence make regex-based
replacement rather reliable (very few false positive).
Unquoted stuff are more problematic since you can have for example
You should run `git foo --bar boz`
or multi-lines formatted code blocks, and a naive regex would match
--bar.
> I think those could be a separate series, but if anybody wants to look
> for them, I think searching for "\--" will help (a literal double-dash
> needs that to avoid becoming an emdash).
The rule seems to be more complex than this, for example "Implies
--porcelain" in https://git-scm.com/docs/git-blame is properly typeset,
although the source code has no escaping or quoting.
I'll keep these out of the series for now, I've added more ideas to
https://git.wiki.kernel.org/index.php/SmallProjectsIdeas#Fix_asciidoc_formatting_in_documentation
I may come back to this later.
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
next prev parent reply other threads:[~2016-06-28 8:27 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-27 17:46 [PATCH 1/6] doc: typeset short command-line options as literal Matthieu Moy
2016-06-27 17:46 ` [PATCH 2/6] doc: typeset long " Matthieu Moy
2016-06-27 19:04 ` Jeff King
2016-06-28 8:08 ` Matthieu Moy
2016-06-28 15:19 ` Junio C Hamano
2016-06-27 17:46 ` [PATCH 3/6] doc: typeset -- as litteral Matthieu Moy
2016-06-27 19:10 ` Jeff King
2016-06-28 8:26 ` Matthieu Moy [this message]
2016-06-27 17:46 ` [PATCH 4/6] doc: typeset long options with argument " Matthieu Moy
2016-06-27 17:46 ` [PATCH 5/6] CodingGuidelines: formatting HEAD in documentation Matthieu Moy
2016-06-27 17:46 ` [PATCH 6/6] doc: typeset HEAD and variants as litteral Matthieu Moy
2016-06-27 18:57 ` [PATCH 1/6] doc: typeset short command-line options as literal Jeff King
2016-06-28 8:31 ` Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 0/7] literal formatting in documentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 1/7] Documentation/git-mv.txt: fix whitespace indentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 2/7] doc: typeset short command-line options as literal Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 3/7] doc: typeset long " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 4/7] doc: typeset '--' " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 5/7] doc: typeset long options with argument " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 6/7] CodingGuidelines: formatting HEAD in documentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 7/7] doc: typeset HEAD and variants as literal Matthieu Moy
2016-06-30 6:42 ` [PATCH v2 0/7] literal formatting in documentation Jeff King
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=vpqa8i5zpkd.fsf@anie.imag.fr \
--to=matthieu.moy@grenoble-inp.fr \
--cc=erwan.mathoniere@ensimag.grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jordan.de-gea@ensimag.grenoble-inp.fr \
--cc=peff@peff.net \
--cc=samuel.groot@ensimag.grenoble-inp.fr \
--cc=tom.russello@ensimag.grenoble-inp.fr \
/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).