Re: [PATCH] http.proxy: also mention https_proxy and all_proxy

From: Jeff King <peff@peff.net>
Date: Mar 3, 2012, 17:42 UTC
Message-ID: <20120303174252.GC28602@sigill.intra.peff.net>
In-Reply-To: <20120303145053.GA29948@ecki>

On Sat, Mar 03, 2012 at 03:50:53PM +0100, Clemens Buchacher wrote:

Show 6 quoted lines

> The current wording of the http.proxy documentation suggests that
> http_proxy is somehow equivalent to http.proxy. However, while
> http.proxy (by the means of curl's CURLOPT_PROXY option) overrides the
> proxy for both HTTP and HTTPS protocols, the http_proxy environment
> variable is used only for HTTP. But since the docs mention only
> http_proxy, a user might expect it to apply to all HTTP-like protocols.

Hmm, I didn't know that. This certainly adds an interesting twist to the patch in a nearby thread to start reading http_proxy ourselves.

Show 15 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index abeb82b..7d197bb 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1258,9 +1258,10 @@ help.autocorrect::
>  	This is the default.
>  
>  http.proxy::
> -	Override the HTTP proxy, normally configured using the 'http_proxy'
> -	environment variable (see linkgit:curl[1]).  This can be overridden
> -	on a per-remote basis; see remote.<name>.proxy
> +	Override the HTTP proxy, normally configured using the 'http_proxy',
> +	'https_proxy', and 'all_proxy' environment variables (see
> +	linkgit:curl[1]).  This can be overridden on a per-remote basis; see
> +	remote.<name>.proxy

Text looks OK. I think this linkgit:curl is wrong, though. In the manpages, it formats as simply curl(1), but in the HTML pages, it creates a link to curl.html, which does not exist. This is not a problem introduced by your patch, obviously, but maybe it is worth cleaning up. I think just using:

  `curl(1)`

might be sufficient.

-Peff