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

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Jun 6, 2016, 14:08 UTC
Message-ID: <vpqinxmmmu8.fsf@anie.imag.fr>
In-Reply-To: <20160606100905.23006-3-tom.russello@grenoble-inp.org>

Tom Russello <tom.russello@grenoble-inp.org> writes:

Show 5 quoted lines

> As a first step, this change GIT_* variables that where in
> italic style to monospace font according to the guideline. It was obtained
> with
>
> 	perl -pi -e "s/\'(GIT_.*?)\'/\`\1\`/g" *.txt

Good.

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.

Show 9 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.

You can catch this one and a handful others with

  git grep "'[A-Z_]*' environment"

(That would be a separate patch)

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/