diff options
| author | Junio C Hamano <gitster@pobox.com> | 2016-07-13 11:24:14 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-07-13 11:24:14 -0700 |
| commit | ce18123cec7674b58bb57272fdfa28de6ecc6b18 (patch) | |
| tree | fce7f39f74bb41dd3dc6d730752c24fc4ddda2c9 /Documentation/CodingGuidelines | |
| parent | fc8a3a607227297a5ec7b0ac60173a82b84b248f (diff) | |
| parent | 661c3e9bc064564a492281364413dc805eaddf95 (diff) | |
| download | git-ce18123cec7674b58bb57272fdfa28de6ecc6b18.tar.xz | |
Merge branch 'mm/doc-tt'
More mark-up updates to typeset strings that are expected to
literally typed by the end user in fixed-width font.
* mm/doc-tt:
doc: typeset HEAD and variants as literal
CodingGuidelines: formatting HEAD in documentation
doc: typeset long options with argument as literal
doc: typeset '--' as literal
doc: typeset long command-line options as literal
doc: typeset short command-line options as literal
Documentation/git-mv.txt: fix whitespace indentation
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 |