Andrew's git
/
gitweb.git
/ diff
summary
|
log
|
commit
| diff |
tree
commit
grep
author
committer
pickaxe
?
re
CodingGuidelines: formatting HEAD in documentation
author
Matthieu Moy
<Matthieu.Moy@imag.fr>
Tue, 28 Jun 2016 11:40:14 +0000
(13:40 +0200)
committer
Junio C Hamano
<gitster@pobox.com>
Tue, 28 Jun 2016 15:36:45 +0000
(08:36 -0700)
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>
Documentation/CodingGuidelines
patch
|
blob
|
history
raw
|
patch
|
inline
| side by side (parent:
bb72e10
)
diff --git
a/Documentation/CodingGuidelines
b/Documentation/CodingGuidelines
index 7f4769a02c049c5669bd02273cf19955b169f58c..4cd95da6b1e436c8764d51f17ea0446ca3bad73d 100644
(file)
--- 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,
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`
`--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
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