git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[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
Previous: Matthieu MoyNext: Matthieu Moy
Message 20 of 22 in “doc: typeset short command-line options as literal”
  1. 1/6 doc: typeset short command-line options as literalMatthieu Moy, Jun 27, 2016
  2. 3/6 doc: typeset -- as litteralMatthieu Moy, Jun 27, 2016
  3. Jeff KingJun 27, 2016
  4. Matthieu MoyJun 28, 2016
  5. 4/6 doc: typeset long options with argument as litteralMatthieu Moy, Jun 27, 2016
  6. 5/6 CodingGuidelines: formatting HEAD in documentationMatthieu Moy, Jun 27, 2016
  7. 6/6 doc: typeset HEAD and variants as litteralMatthieu Moy, Jun 27, 2016
  8. 2/6 doc: typeset long command-line options as literalMatthieu Moy, Jun 27, 2016
  9. Jeff KingJun 27, 2016
  10. Matthieu MoyJun 28, 2016
  11. Junio C HamanoJun 28, 2016
  12. Jeff KingJun 27, 2016
  13. Matthieu MoyJun 28, 2016
  14. 0/7 literal formatting in documentationMatthieu Moy, Jun 28, 2016
  15. 7/7 doc: typeset HEAD and variants as literalMatthieu Moy, Jun 28, 2016
  16. 5/7 doc: typeset long options with argument as literalMatthieu Moy, Jun 28, 2016
  17. 1/7 Documentation/git-mv.txt: fix whitespace indentationMatthieu Moy, Jun 28, 2016
  18. 4/7 doc: typeset '--' as literalMatthieu Moy, Jun 28, 2016
  19. 3/7 doc: typeset long command-line options as literalMatthieu Moy, Jun 28, 2016
  20. 6/7 CodingGuidelines: formatting HEAD in documentationMatthieu Moy, Jun 28, 2016
  21. 2/7 doc: typeset short command-line options as literalMatthieu Moy, Jun 28, 2016
  22. Jeff KingJun 30, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.