From: "Jean-Noël Avila" <avila.jn@gmail.com>
To: git <git@vger.kernel.org>
Subject: Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
Date: Mon, 12 Apr 2021 15:37:28 +0200 [thread overview]
Message-ID: <d2e78646-6735-2a27-735c-331de6411ca2@gmail.com> (raw)
In-Reply-To: <20210409040301.3260358-1-firminmartin24@gmail.com>
Le 09/04/2021 à 06:02, Firmin Martin a écrit :
> This patch series aims to make the documentation fully compliant to the
> CodingGuidelines regarding monospace font. After it, new contributors
> who just want to change a little portion of the documention could just
> look around how it has been done without being confused by the
> inconsistency between the documentation and the CodingGuidelines.
Thank you for tackling the task of formating the docu and directing to
CodingGuidelines for some markup rules. It appears that the last rule
about backticks is wrong with late Asciidoctor, for which backticks are
only a font switcher and no longer hold any semantic meaning. This means
that double-hyphens may need escaping (see:
https://asciidoctor.org/docs/migration/#migration-cheatsheet) when
switching style and tools.
One other rule worth adding would be that tabs are banned from asciidoc
because they cannot always be matched with correct indentation.
next prev parent reply other threads:[~2021-04-12 13:37 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
2021-04-09 9:49 ` Bagas Sanjaya
2021-04-10 1:12 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 02/13] doc: typeset branches and remotes " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 03/13] doc: typeset configuration options " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 04/13] doc: typeset git-related commands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 05/13] doc: typeset git-svn subcommands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 07/13] doc: typeset git dotfiles " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 08/13] doc: typeset filepath and $variables " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 09/13] doc: typeset command/option/value entries " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 10/13] doc: typeset more command " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 11/13] doc: typeset config option " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 12/13] doc: typeset environment vars without $ " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 13/13] doc: typeset common programs " Firmin Martin
2021-04-12 13:37 ` Jean-Noël Avila [this message]
2021-04-13 20:42 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-19 9:04 ` Jean-Noël Avila
2021-04-19 9:33 ` Jean-Noël Avila
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=d2e78646-6735-2a27-735c-331de6411ca2@gmail.com \
--to=avila.jn@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.
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 NNTP newsgroup(s).