undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CodingGuidelines: formatting HEAD in documentation

Browse Source 
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>
This commit is contained in:
Matthieu Moy 2016-06-28 13:40:14 +02:00 committed by Junio C Hamano
parent bb72e10a41
commit 57103dbf70
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/CodingGuidelines
View File

@ -527,12 +527,13 @@ Writing Documentation:
or commands: or commands:
Literal examples (e.g. use of command-line options, command names, Literal examples (e.g. use of command-line options, command names,
configuration and environment variables) must be typeset in monospace (i.e. branch names, configuration and environment variables) must be
wrapped with backticks): typeset in monospace (i.e. wrapped with backticks):
`--pretty=oneline` `--pretty=oneline`
`git rev-list` `git rev-list`
`remote.pushDefault` `remote.pushDefault`
`GIT_DIR` `GIT_DIR`
`HEAD`
An environment variable must be prefixed with "$" only when referring to its 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 value and not when referring to the variable itself, in this case there is