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

Re: [PATCH v4 3/3] doc: more consistency in environment variables format

From
Johannes Sixt <j6t@kdbg.org>
Date
Jun 8, 2016, 06:56 UTC
Message-ID
<5757C1B4.5060709@kdbg.org>
In-Reply-To
<20160607223507.18061-4-tom.russello@grenoble-inp.org>
Am 08.06.2016 um 00:35 schrieb Tom Russello:
Show 24 quoted lines
> Wrap with backticks (monospaced font) unwrapped or single-quotes wrapped
> (italic type) environment variables which are followed by the word
> "environment". It was obtained with:
>
> perl -pi -e "s/\'?(\\\$?[0-9A-Z\_]+)\'?(?= environment ?)/\`\1\`/g" *.txt
>
> One of the main purposes is to stick to the CodingGuidelines as possible so
> that people writting new documentation by mimicking the existing are more likely
> to have it right (even if they didn't read the CodingGuidelines).
>
> Signed-off-by: Tom Russello <tom.russello@grenoble-inp.org>
> Signed-off-by: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>
> Signed-off-by: Samuel Groot <samuel.groot@grenoble-inp.org>
> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> ---
> One reason behind the creation of this patch is that patch [2/3] led to minor
> inconsistencies in some sentences as it only deals with GIT_* environment
> variables and let others unchanged (for example `GIT_ASKPASS` and 'SSH_ASKPASS'
> in Documentation/config.txt).
>
> For this one, I had to manually change GIT_AUTHOR_DATE
> (Documentation/date-formats.txt - l.4) and GIT_EXTERNAL_DIFF
> (Documentation/diff-generate-patch.txt - l.9) as the perl command didn't manage
> these cases and so created minor inconsistencies.
This last paragraph should go into the commit message.

Also, you should investigate cases where "environment" is at the beginning of a line, because then the variable name is most likely at the end of the previous line. At the least, you missed an occurrence of GIT_EXTERNAL_DIFF in diff-config.txt.

-- Hannes
Previous: Tom RusselloNext: Matthieu Moy
Message 32 of 34 in “Formatting variables in the documentation”
  1. Formatting variables in the documentationTom Russello, May 18, 2016
  2. Jeff KingMay 18, 2016
  3. Samuel GROOTMay 23, 2016
  4. Matthieu MoyMay 23, 2016
  5. Jeff KingMay 26, 2016
  6. Junio C HamanoMay 26, 2016
  7. Jeff KingMay 26, 2016
  8. Junio C HamanoMay 26, 2016
  9. Jeff KingMay 26, 2016
  10. Documentation: bold literals in manErwan Mathoniere, May 31, 2016
  11. Documentation more consistentTom Russello, Jun 3, 2016
  12. 1/3 Clearer rule about formatting literalsTom Russello, Jun 3, 2016
  13. 2/3 Change environment variables formatTom Russello, Jun 3, 2016
  14. 3/3 Change configuration variables formatTom Russello, Jun 3, 2016
  15. Junio C HamanoJun 3, 2016
  16. Documentation more consistentTom Russello, Jun 6, 2016
  17. 1/3 doc: clearer rule about formatting literalsTom Russello, Jun 6, 2016
  18. Matthieu MoyJun 6, 2016
  19. Matthieu MoyJun 6, 2016
  20. Tom RusselloJun 6, 2016
  21. 2/3 doc: change environment variables formatTom Russello, Jun 6, 2016
  22. Matthieu MoyJun 6, 2016
  23. Tom RusselloJun 6, 2016
  24. 3/3 doc: change configuration variables formatTom Russello, Jun 6, 2016
  25. Matthieu MoyJun 6, 2016
  26. 0/3 Documentation more consistentTom Russello, Jun 7, 2016
  27. 1/3 doc: clearer rule about formatting literalsTom Russello, Jun 7, 2016
  28. 2/3 doc: change environment variables formatTom Russello, Jun 7, 2016
  29. 3/3 doc: more consistency in environment variables formatTom Russello, Jun 7, 2016
  30. Matthieu MoyJun 8, 2016
  31. Tom RusselloJun 8, 2016
  32. Johannes SixtJun 8, 2016
  33. Matthieu MoyJun 8, 2016
  34. 4/3 doc: change configuration variables formatTom Russello, Jun 8, 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.