threads / patch / 9496

patchDocumentation: List environmental variables which were missing

Subject: [PATCH] Documentation: List environmental variables which were missing

## tl;dr

2 messages between Aug 11, 2007 and Aug 12, 2007. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Jakub Narebski· Aug 11, 2007, 22:38 UTC · lore

Add to list environmental variables in "Environment variables" section of git(7) which are documented on other manpages, but were missing in the list, in the form of link to appropriate manpage (similarly to how GIT_AUTHOR_* variables are documented in git(7)).

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
 Documentation/git.txt |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
Show changes to Documentation/git.txt +18 −0
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 18f8b6a..8a0399e 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -411,6 +411,24 @@ parameter, <path>.
 
 other
 ~~~~~
+'GIT_CONFIG'::
+'GIT_CONFIG_LOCAL'::
+	Specifies config file.
+	See gitlink:git-config[1]
+
+'GIT_PROXY_COMMAND'::
+'GIT_SSL_NO_VERIFY'::
+'GIT_SSL_CERT'::
+'GIT_SSL_KEY'::
+'GIT_SSL_CAINFO'::
+'GIT_SSL_CAPATH'::
+'GIT_HTTP_MAX_REQUESTS'::
+'GIT_HTTP_LOW_SPEED_LIMIT'::
+'GIT_HTTP_LOW_SPEED_TIME'::
+'GIT_CURL_FTP_NO_EPSV'::
+	Overrides appropriate configuration variable.
+	See gitlink:git-config[1]
+
 'GIT_MERGE_VERBOSITY'::
 	A number controlling the amount of output shown by
 	the recursive merge strategy.  Overrides merge.verbosity.

-- 
1.5.2.4
Junio C Hamano· Aug 12, 2007, 01:38 UTC · re: Jakub Narebski · lore

Re: [PATCH] Documentation: List environmental variables which were missing

Jakub Narebski <jnareb@gmail.com> writes:
> Add to list environmental variables in "Environment variables" section
> of git(7)...

These are "environment variables", not "environmental". You have the same typo in gitweb/INSTALL, I think.

Show 6 quoted lines
>  other
>  ~~~~~
> +'GIT_CONFIG'::
> +'GIT_CONFIG_LOCAL'::
> +	Specifies config file.
> +	See gitlink:git-config[1]

I think this should probably be listed next to GIT_DIR and friends.

Isn't "Specifies config file" way too vague to be any useful?

If you do not describe them enough on this page, saying "there are other environment variables that affect the operation of git; see git-config[1] for details" without listing them is just as useful (or, just as useless). At least doing so would need much less maintenance.

Show 12 quoted lines
> +'GIT_PROXY_COMMAND'::
> +'GIT_SSL_NO_VERIFY'::
> +'GIT_SSL_CERT'::
> +'GIT_SSL_KEY'::
> +'GIT_SSL_CAINFO'::
> +'GIT_SSL_CAPATH'::
> +'GIT_HTTP_MAX_REQUESTS'::
> +'GIT_HTTP_LOW_SPEED_LIMIT'::
> +'GIT_HTTP_LOW_SPEED_TIME'::
> +'GIT_CURL_FTP_NO_EPSV'::
> +	Overrides appropriate configuration variable.
> +	See gitlink:git-config[1]

I wonder if it is worth it to add them in this form (the same "usefulness vs maintenance hassle" comment applies to the vagueness of "appropriate variable").

Everything other than GIT_PROXY_COMMAND is for http fetch, isn't it? At least you could say something like:

	Used to override http.* configuration variables (see
	gitlink:git-config[1])

← back to recent threads