Tom Russello <tom.russe...@grenoble-inp.org> writes: > --- a/Documentation/CodingGuidelines > +++ b/Documentation/CodingGuidelines > @@ -526,12 +526,13 @@ Writing Documentation: > modifying paragraphs or option/command explanations that contain options > or commands: > > - Literal examples (e.g. use of command-line options, command names, and > - configuration variables) are typeset in monospace, and if you can use > - `backticks around word phrases`, do so. > + 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): > `--pretty=oneline` > `git rev-list` > `remote.pushDefault` > + `GIT_DIR`
Don't you want `$GIT_DIR` here? > Word phrases enclosed in `backtick characters` are rendered literally > and will not be further expanded. The use of `backticks` to achieve the It might make sense to mention that they will appear bold in manpages too. -- Matthieu Moy http://www-verimag.imag.fr/~moy/ -- 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
