admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add markup for characters in Guidelines

Browse Source 
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>
This commit is contained in:
Jean-Noël Avila
2025-04-12 12:20:50 +00:00
committed by Junio C Hamano
parent c87b2b3a6f
commit 5a5565ec44
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/CodingGuidelines
View File

@@ -861,6 +861,9 @@ Markup:
_<git-dir>_ _<git-dir>_
_<key-id>_ _<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 Git's Asciidoc processor has been tailored to treat backticked text
as complex synopsis. When literal and placeholders are mixed, you can as complex synopsis. When literal and placeholders are mixed, you can
use the backtick notation which will take care of correctly typesetting use the backtick notation which will take care of correctly typesetting