File tree Expand file tree Collapse file tree 1 file changed +10
-3
lines changed Expand file tree Collapse file tree 1 file changed +10
-3
lines changed Original file line number Diff line number Diff line change @@ -526,12 +526,19 @@ Writing Documentation:
526
526
modifying paragraphs or option/command explanations that contain options
527
527
or commands:
528
528
529
- Literal examples (e.g. use of command-line options, command names, and
530
- configuration variables) are typeset in monospace, and if you can use
531
- `backticks around word phrases`, do so.
529
+ Literal examples (e.g. use of command-line options, command names,
530
+ configuration and environment variables) must be typeset in monospace (i.e.
531
+ wrapped with backticks):
532
532
`--pretty=oneline`
533
533
`git rev-list`
534
534
`remote.pushDefault`
535
+ `GIT_DIR`
536
+
537
+ An environment variable must be prefixed with "$" only when referring to its
538
+ value and not when referring to the variable itself, in this case there is
539
+ nothing to add except the backticks:
540
+ `GIT_DIR` is specified
541
+ `$GIT_DIR/hooks/pre-receive`
535
542
536
543
Word phrases enclosed in `backtick characters` are rendered literally
537
544
and will not be further expanded. The use of `backticks` to achieve the
You can’t perform that action at this time.
0 commit comments