Skip to content

Commit 57103db

Browse files
moygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bb72e10 commit 57103db

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/CodingGuidelines

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,12 +527,13 @@ Writing Documentation:
527527
or commands:
528528

529529
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):
532532
`--pretty=oneline`
533533
`git rev-list`
534534
`remote.pushDefault`
535535
`GIT_DIR`
536+
`HEAD`
536537

537538
An environment variable must be prefixed with "$" only when referring to its
538539
value and not when referring to the variable itself, in this case there is

0 commit comments

Comments
 (0)