The man pages contain inconsistent usage of backticks vs. single quotes around options and commands that are in paragraphs. This commit states that backticks should always be used around options and commands.
This commit also states that "--" and friends should be left unescaped (e.g. use `--pretty=oneline` instead of `\--pretty=oneline`). Signed-off-by: Jason St. John <jstj...@purdue.edu> --- This was discussed here: http://marc.info/?l=git&m=138419319223845&w=2 http://marc.info/?l=git&m=138424552300662&w=2 Documentation/CodingGuidelines | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index a600e35..b335d48 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -260,9 +260,11 @@ Writing Documentation: Every user-visible change should be reflected in the documentation. The same general rule as for code applies -- imitate the existing - conventions. A few commented examples follow to provide reference - when writing or modifying command usage strings and synopsis sections - in the manual pages: + conventions. + + A few commented examples follow to provide reference when writing or + modifying command usage strings and synopsis sections in the manual + pages: Placeholders are spelled in lowercase and enclosed in angle brackets: <file> @@ -312,3 +314,17 @@ Writing Documentation: Use 'git' (all lowercase) when talking about commands i.e. something the user would type into a shell and use 'Git' (uppercase first letter) when talking about the version control system and its properties. + + A few commented examples follow to provide reference when writing or + modifying paragraphs or option/command explanations that contain options + or commands: + + Backticks are used around options or commands: + `--pretty=oneline` + `git rev-list` + + Options or commands should use unescaped AsciiDoc: + Correct: + `--pretty=oneline` + Incorrect: + `\--pretty=oneline` -- 220.127.116.11 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html