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

Re: [PATCH v3 2/3] doc: change environment variables format

From
TRTom Russello <tom.russello@grenoble-inp.org>
Date
Jun 6, 2016, 16:34 UTC
Message-ID
<57e1e906-1314-e774-4ca6-89cf772ce19d@grenoble-inp.org>
In-Reply-To
<vpqinxmmmu8.fsf@anie.imag.fr>
On 06/06/16 16:08, Matthieu Moy wrote:
Show 5 quoted lines
> I'd add to the commit message that one of the goals of this patch is to
> make the use "mostly consistent" with CodingGuidelines, so that people
> writting new doc by mimicking the existing one later get a good
> probability of getting it right even if they didn't read
> CodingGuidelines.
Agreed.
Show 11 quoted lines
>> @@ -619,7 +619,7 @@ core.excludesFile::
>>  core.askPass::
>>  	Some commands (e.g. svn and http interfaces) that interactively
>>  	ask for a password can be told to use an external program given
>> -	via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
>> +	via the value of this variable. Can be overridden by the `GIT_ASKPASS`
>>  	environment variable. If not set, fall back to the value of the
>>  	'SSH_ASKPASS' environment variable or, failing that, a simple password
>>  	prompt. The external program shall be given a suitable prompt as
> 
> We now have a minor inconsistency between GIT_ASKPASS and SSH_ASKPASS.
This is the side effect of changing only one pattern (GIT_*)
> You can catch this one and a handful others with
> 
>   git grep "'[A-Z_]*' environment"

With this regex, we can even catch environment variables without any format or prefixed with '$':

git grep ".'\?\$\?[0-9A-Z_]\+'\? environment "
> (That would be a separate patch)
I'm on it.
Thank you.
Previous: Matthieu MoyNext: Tom Russello
Message 23 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.