From: Jean-Noël Avila <jn.avila@free.fr>
Date: Sat, 12 Apr 2025 12:20:50 +0000 (+0000)
Subject: doc: add markup for characters in Guidelines
X-Git-Tag: v2.50.0-rc0~89^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5a5565ec44293869884eb5da2e08bda832616171;p=thirdparty%2Fgit.git

doc: add markup for characters in Guidelines

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index a0e7041c54..c1046abfb7 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