Skip to content

Commit

Permalink
CodingGuidelines: formatting HEAD in documentation
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
moy authored and gitster committed Jun 28, 2016
1 parent bb72e10 commit 57103db
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 57103db

Please sign in to comment.