From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
"Jean-Noël Avila" <jn.avila@free.fr>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v2 7/7] doc: add markup for characters in Guidelines
Date: Sat, 12 Apr 2025 12:20:50 +0000 [thread overview]
Message-ID: <2690f84602b89f1b10652a6381aa96b2e126d6eb.1744460450.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1896.v2.git.1744460450.gitgitgadget@gmail.com>
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
This rule was already implicitely applied in the converted man pages,
so let's state it loudly.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
Documentation/CodingGuidelines | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index a0e7041c54b..c1046abfb7d 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -861,6 +861,9 @@ Markup:
_<git-dir>_
_<key-id>_
+Characters are also surrounded by underscores:
+ _LF_, _CR_, _CR_/_LF_, _NUL_, _EOF_
+
Git's Asciidoc processor has been tailored to treat backticked text
as complex synopsis. When literal and placeholders are mixed, you can
use the backtick notation which will take care of correctly typesetting
--
gitgitgadget
next prev parent reply other threads:[~2025-04-12 12:21 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-30 17:15 [PATCH 0/5] doc: convert git-reset, git-rm and git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-03-30 17:16 ` [PATCH 1/5] doc: convert git-reset " Jean-Noël Avila via GitGitGadget
2025-04-04 16:39 ` Martin Ågren
2025-03-30 17:16 ` [PATCH 2/5] doc: fix synopsis analysis logic Jean-Noël Avila via GitGitGadget
2025-04-04 16:39 ` Martin Ågren
2025-04-12 8:58 ` Jean-Noël Avila
2025-03-30 17:16 ` [PATCH 3/5] doc: convert git-rm to new documentation format Jean-Noël Avila via GitGitGadget
2025-03-30 17:16 ` [PATCH 4/5] doc: move synopsis git-mv commands in the synopsis section Jean-Noël Avila via GitGitGadget
2025-04-05 10:57 ` Martin Ågren
2025-03-30 17:16 ` [PATCH 5/5] doc: convert git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 0/7] doc: convert git-reset, git-rm and " Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 1/7] doc: convert git-reset " Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 2/7] doc: fix synopsis analysis logic Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 3/7] doc: convert git-rm to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 4/7] doc: move synopsis git-mv commands in the synopsis section Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 5/7] doc: convert git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` [PATCH v2 6/7] doc: fix asciidoctor synopsis processing of triple-dots Jean-Noël Avila via GitGitGadget
2025-04-12 12:20 ` Jean-Noël Avila via GitGitGadget [this message]
2025-04-14 21:47 ` [PATCH v2 0/7] doc: convert git-reset, git-rm and git-mv to new documentation format Junio C Hamano
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=2690f84602b89f1b10652a6381aa96b2e126d6eb.1744460450.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
--cc=martin.agren@gmail.com \
/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).