Thread (17 messages) flat view 17 messages, 4 authors, 2016-06-16

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

From: Johannes Sixt <hidden>
Date: 2016-06-16 02:19:48

Am 08.06.2016 um 00:35 schrieb Tom Russello:
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 <redacted>
Signed-off-by: Erwan Mathoniere <redacted>
Signed-off-by: Samuel Groot <redacted>
Signed-off-by: Matthieu Moy <redacted>
---
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help