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>
Matthieu Moy committed
Jun 28, 2016 at 13:40 UTC
57103dbf702557abefc7c8c4578145f9383d6e9d
1 file changed
+3
-2
Documentation/CodingGuidelines
+3
-2
@@ -527,12 +527,13 @@ Writing Documentation:
527
or commands:
528
529
Literal examples (e.g. use of command-line options, command names,
530
- configuration and environment variables) must be typeset in monospace (i.e.
531
- wrapped with backticks):
530
+ branch names, configuration and environment variables) must be
531
+ typeset in monospace (i.e. wrapped with backticks):
532
`--pretty=oneline`
533
`git rev-list`
534
`remote.pushDefault`
535
`GIT_DIR`
536
+ `HEAD`
537
538
An environment variable must be prefixed with "$" only when referring to its
539
value and not when referring to the variable itself, in this case there is