Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jakub Narebski <jnareb@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: List environmental variables which were missing
Date: Sat, 11 Aug 2007 18:38:52 -0700	[thread overview]
Message-ID: <7v643llefn.fsf@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: <1186871917846-git-send-email-jnareb@gmail.com> (Jakub Narebski's message of "Sun, 12 Aug 2007 00:38:37 +0200")

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.

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

> +'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])

      reply	other threads:[~2007-08-12  1:38 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-08-11 22:38 [PATCH] Documentation: List environmental variables which were missing Jakub Narebski
2007-08-12  1:38 ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7v643llefn.fsf@assigned-by-dhcp.cox.net \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jnareb@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox