diff options
| author | Jason St. John <jstjohn@purdue.edu> | 2013-11-14 18:08:45 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-11-18 13:30:51 -0800 |
| commit | ca03c3682a45c9c10273cbdfaa48edea084ffd11 (patch) | |
| tree | 5c2832d915a4692f0ed2abde7e38fef32b2d92bb /Documentation/git-update-ref.txt | |
| parent | d7d2c87955f7700289c5b516f12579a5be4b879d (diff) | |
| download | git-ca03c3682a45c9c10273cbdfaa48edea084ffd11.tar.gz | |
State correct usage of literal examples in man pages in the coding standardsjj/doc-markup-hints-in-coding-guidelines
The man pages contain inconsistent usage of backticks vs. single quotes
around options, commands, etc. that are in paragraphs. This commit states
that backticks should always be used around literal examples.
This commit states that "--" and friends should not be escaped
(e.g. use `--pretty=oneline` instead of `\--pretty=oneline`).
This commit also states correct usage for typesetting command usage
examples with inline substitutions.
Thanks-to: Ramkumar Ramachandra <artagnon@gmail.com>
Thanks-to: Stuart Rackham <srackham@gmail.com>
Thanks-to: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Jason St. John <jstjohn@purdue.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-update-ref.txt')
0 files changed, 0 insertions, 0 deletions