diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2025-04-12 12:20:50 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-04-14 14:43:53 -0700 |
| commit | 5a5565ec44293869884eb5da2e08bda832616171 (patch) | |
| tree | f0303f743add2c7d5a39a38725ad8052b084129e | |
| parent | c87b2b3a6f13ed8d98cf2bdf863af85175a623a5 (diff) | |
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>
| -rw-r--r-- | Documentation/CodingGuidelines | 3 |
1 files changed, 3 insertions, 0 deletions
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 |