State correct usage of literal examples in man pages in the coding standards
commitca03c3682a45c9c10273cbdfaa48edea084ffd11
authorJason St. John <jstjohn@purdue.edu>
Thu, 14 Nov 2013 23:08:45 +0000 (14 18:08 -0500)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2013 21:30:51 +0000 (18 13:30 -0800)
tree5c2832d915a4692f0ed2abde7e38fef32b2d92bb
parentd7d2c87955f7700289c5b516f12579a5be4b879d
State correct usage of literal examples in man pages in the coding standards

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>
Documentation/CodingGuidelines