From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: gitster@pobox.com
Cc: git@vger.kernel.org,
Jordan DE GEA <jordan.de-gea@ensimag.grenoble-inp.fr>,
Samuel GROOT <samuel.groot@ensimag.grenoble-inp.fr>,
Erwan MATHONIERE <erwan.mathoniere@ensimag.grenoble-inp.fr>,
Tom RUSSELLO <tom.russello@ensimag.grenoble-inp.fr>,
Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH 5/6] CodingGuidelines: formatting HEAD in documentation
Date: Mon, 27 Jun 2016 19:46:22 +0200 [thread overview]
Message-ID: <20160627174623.11084-5-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <20160627174623.11084-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
next prev parent reply other threads:[~2016-06-27 17:47 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-27 17:46 [PATCH 1/6] doc: typeset short command-line options as literal Matthieu Moy
2016-06-27 17:46 ` [PATCH 2/6] doc: typeset long " Matthieu Moy
2016-06-27 19:04 ` Jeff King
2016-06-28 8:08 ` Matthieu Moy
2016-06-28 15:19 ` Junio C Hamano
2016-06-27 17:46 ` [PATCH 3/6] doc: typeset -- as litteral Matthieu Moy
2016-06-27 19:10 ` Jeff King
2016-06-28 8:26 ` Matthieu Moy
2016-06-27 17:46 ` [PATCH 4/6] doc: typeset long options with argument " Matthieu Moy
2016-06-27 17:46 ` Matthieu Moy [this message]
2016-06-27 17:46 ` [PATCH 6/6] doc: typeset HEAD and variants " Matthieu Moy
2016-06-27 18:57 ` [PATCH 1/6] doc: typeset short command-line options as literal Jeff King
2016-06-28 8:31 ` Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 0/7] literal formatting in documentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 1/7] Documentation/git-mv.txt: fix whitespace indentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 2/7] doc: typeset short command-line options as literal Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 3/7] doc: typeset long " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 4/7] doc: typeset '--' " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 5/7] doc: typeset long options with argument " Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 6/7] CodingGuidelines: formatting HEAD in documentation Matthieu Moy
2016-06-28 11:40 ` [PATCH v2 7/7] doc: typeset HEAD and variants as literal Matthieu Moy
2016-06-30 6:42 ` [PATCH v2 0/7] literal formatting in documentation Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160627174623.11084-5-Matthieu.Moy@imag.fr \
--to=matthieu.moy@imag.fr \
--cc=erwan.mathoniere@ensimag.grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jordan.de-gea@ensimag.grenoble-inp.fr \
--cc=samuel.groot@ensimag.grenoble-inp.fr \
--cc=tom.russello@ensimag.grenoble-inp.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).