]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: add markup for characters in Guidelines
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 12 Apr 2025 12:20:50 +0000 (12:20 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 14 Apr 2025 21:43:53 +0000 (14:43 -0700)
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>
Documentation/CodingGuidelines

index a0e7041c54b4976c565ef4f6ff26c612fa6a6303..c1046abfb7d10bf147fb38fc43b7bb860c23b854 100644 (file)
@@ -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