From: Johannes Sixt Date: Wed, 08 Jun 2016 06:56:52 GMT Subject: Re: [PATCH v4 3/3] doc: more consistency in environment variables format 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: > 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 > Signed-off-by: Erwan Mathoniere > Signed-off-by: Samuel Groot > Signed-off-by: Matthieu Moy > --- > 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