diff options
| author |  Tom Russello <tom.russello@grenoble-inp.org> | 2016-06-08 00:35:05 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2016-06-08 12:04:37 -0700 |
| commit | 41f5b21f84b4d7db8e8c6edb34682c0f840ad8c8 (patch) | |
| tree | 6200dbb6a10c67a974c12537dcac1a8f3896744d /Documentation | |
| parent | Git 2.8.4 (diff) | |
| download | tgif-41f5b21f84b4d7db8e8c6edb34682c0f840ad8c8.tar.xz | |
doc: clearer rule about formatting literals
Make the guideline text that we want for our documentation clearer.
Signed-off-by: Tom Russello <tom.russello@grenoble-inp.org>
Signed-off-by: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>
Signed-off-by: Samuel Groot <samuel.groot@grenoble-inp.org>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 0ddd36879a..7f4769a02c 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -526,12 +526,19 @@ Writing Documentation: modifying paragraphs or option/command explanations that contain options or commands: - Literal examples (e.g. use of command-line options, command names, and - configuration variables) are typeset in monospace, and if you can use - `backticks around word phrases`, do so. + 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): `--pretty=oneline` `git rev-list` `remote.pushDefault` + `GIT_DIR` + + 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 + nothing to add except the backticks: + `GIT_DIR` is specified + `$GIT_DIR/hooks/pre-receive` Word phrases enclosed in `backtick characters` are rendered literally and will not be further expanded. The use of `backticks` to achieve the |