path: root/Documentation/CodingGuidelines
diff options
authorJunio C Hamano <>2016-06-27 16:56:42 (GMT)
committerJunio C Hamano <>2016-06-27 16:56:42 (GMT)
commit94c61d25dabd35b18dc64781084a5d14da7be016 (patch)
treeb43d8c6d675d5d55668f5574718014ef0c749fb3 /Documentation/CodingGuidelines
parentaf325b0f9abacda405e19947a929ad5a3a14cb90 (diff)
parentae9f6311e9c15d7968c2d03eab6e929e9c9d5f42 (diff)
Merge branch 'tr/doc-tt'
The documentation set has been updated so that literal commands, configuration variables and environment variables are consistently typeset in fixed-width font and bold in manpages. * tr/doc-tt: doc: change configuration variables format doc: more consistency in environment variables format doc: change environment variables format doc: clearer rule about formatting literals
Diffstat (limited to 'Documentation/CodingGuidelines')
1 files 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):
`git rev-list`
+ 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