[PATCH v2 6/7] CodingGuidelines: formatting HEAD in documentation
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Jun 28, 2016, 11:40 UTC
- Message-ID
- <20160628114015.25828-7-Matthieu.Moy@imag.fr>
- In-Reply-To
- <20160628114015.25828-1-Matthieu.Moy@imag.fr>
The current practice is:
git/Documentation$ git grep "'HEAD'" | wc -l 24 git/Documentation$ git grep "\`HEAD\`" | wc -l 66
Let's adopt the majority as a guideline.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> --- Documentation/CodingGuidelines | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 7f4769a..4cd95da 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -527,12 +527,13 @@ Writing Documentation: or commands: 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): + branch names, configuration and environment variables) must be + typeset in monospace (i.e. wrapped with backticks): `--pretty=oneline` `git rev-list` `remote.pushDefault` `GIT_DIR` + `HEAD` An environment variable must be prefixed with "$" only when referring to its value and not when referring to the variable itself, in this case there is
-- 2.8.2.397.gbe91ebf.dirty