summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorMatthieu Moy <Matthieu.Moy@imag.fr>2016-06-28 11:40:14 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-06-28 15:36:45 (GMT)
commit57103dbf702557abefc7c8c4578145f9383d6e9d (patch)
tree614e9428f4a7d859d7d2d4a6e652d6cbf60cfa2b /Documentation/CodingGuidelines
parentbb72e10a4196dda93afd8afba55e15fb1e5503c4 (diff)
downloadgit-57103dbf702557abefc7c8c4578145f9383d6e9d.zip
git-57103dbf702557abefc7c8c4578145f9383d6e9d.tar.gz
git-57103dbf702557abefc7c8c4578145f9383d6e9d.tar.bz2
CodingGuidelines: formatting HEAD in documentation
The current practice is: git/Documentation$ git grep "'HEAD'" | wc -l 24 git/Documentation$ git grep "\`HEAD\`" | wc -l 66 Let's adopt the majority as a guideline. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 7f4769a..4cd95da 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -527,12 +527,13 @@ Writing Documentation:
or commands:
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):
+ branch names, configuration and environment variables) must be
+ typeset in monospace (i.e. wrapped with backticks):
`--pretty=oneline`
`git rev-list`
`remote.pushDefault`
`GIT_DIR`
+ `HEAD`
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