diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2024-02-21 21:18:59 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-02-21 14:01:46 -0800 |
| commit | 0824639ddf9c8ea9d7857440fb2414e12349f51a (patch) | |
| tree | 7fbe3c7247ee7d6d5cdaea22bfc34bd47e9052d1 /Documentation | |
| parent | 43c8a30d150ecede9709c1f2527c8fba92c65f40 (diff) | |
| download | git-0824639ddf9c8ea9d7857440fb2414e12349f51a.tar.gz | |
doc: clarify the format of placeholders
Add the new format rule when using placeholders in the description of
commands and options.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 65af8d82ce..15195cd976 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -666,6 +666,11 @@ Writing Documentation: <new-branch-name> --template=<template-directory> + When a placeholder is cited in text paragraph, it is enclosed in angle + brackets to remind the reader the reference in the synopsis section. + For better visibility, the placeholder is typeset in italics: + The _<file>_ to be added. + Possibility of multiple occurrences is indicated by three dots: <file>... (One or more of <file>.) @@ -751,6 +756,8 @@ Writing Documentation: Incorrect: `\--pretty=oneline` +A placeholder is not enclosed in backticks, as it is not a literal. + If some place in the documentation needs to typeset a command usage example with inline substitutions, it is fine to use +monospaced and inline substituted text+ instead of `monospaced literal text`, and with |