From: Tom Russello Date: Fri, 03 Jun 2016 22:08:35 GMT Subject: [PATCH v2 1/3] Clearer rule about formatting literals Message-ID: <20160603220837.9842-2-tom.russello@grenoble-inp.org> In-Reply-To: <20160603220837.9842-1-tom.russello@grenoble-inp.org> Make the guideline text that we want for our documentation clearer. Signed-off-by: Tom Russello Signed-off-by: Erwan Mathoniere Signed-off-by: Samuel Groot Signed-off-by: Matthieu Moy --- IMHO, the previous "rule" was not so clear on what we have to do and didn't give a guideline to whether an environment variable has to be wrapped with backticks, single-quotes or something else. Documentation/CodingGuidelines | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 0ddd368..c6f8188 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -526,12 +526,13 @@ Writing Documentation: modifying paragraphs or option/command explanations that contain options or commands: - Literal examples (e.g. use of command-line options, command names, and - configuration variables) are typeset in monospace, and if you can use - `backticks around word phrases`, do so. + Literal examples (e.g. use of command-line options, command names, + configuration and environment variables) must be typeset in monospace (i.e. + wrapped with backticks): `--pretty=oneline` `git rev-list` `remote.pushDefault` + `GIT_DIR` Word phrases enclosed in `backtick characters` are rendered literally and will not be further expanded. The use of `backticks` to achieve the -- 2.8.3