[PATCH v4 1/3] doc: clearer rule about formatting literals
From: Tom Russello <hidden>
Date: 2016-06-16 02:19:47
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Make the guideline text that we want for our documentation clearer. Signed-off-by: Tom Russello <redacted> Signed-off-by: Erwan Mathoniere <redacted> Signed-off-by: Samuel Groot <redacted> Signed-off-by: Matthieu Moy <redacted> --- Changes since v3: - Add the rule of when environment variables must be prefixed with "$" Documentation/CodingGuidelines | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 0ddd368..7f4769a 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines@@ -526,12 +526,19 @@ 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` + + An environment variable must be prefixed with "$" only when referring to its + value and not when referring to the variable itself, in this case there is + nothing to add except the backticks: + `GIT_DIR` is specified + `$GIT_DIR/hooks/pre-receive` 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