diff options
| author |  Matthieu Moy <Matthieu.Moy@imag.fr> | 2016-06-28 13:40:14 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2016-06-28 08:36:45 -0700 |
| commit | 57103dbf702557abefc7c8c4578145f9383d6e9d (patch) | |
| tree | 614e9428f4a7d859d7d2d4a6e652d6cbf60cfa2b /Documentation/CodingGuidelines | |
| parent | doc: typeset long options with argument as literal (diff) | |
| download | tgif-57103dbf702557abefc7c8c4578145f9383d6e9d.tar.xz | |
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>
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 7f4769a02c..4cd95da6b1 100644 --- 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, - 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 |