All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Felipe Contreras <felipe.contreras@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	"J. Bruce Fields" <bfields@citi.umich.edu>,
	Jonathan Nieder <jrnieder@gmail.com>
Subject: Re: [PATCH 1/2] user-manual: add global config section
Date: Sun, 11 Oct 2009 17:27:29 -0500	[thread overview]
Message-ID: <20091011222729.GA5114@progeny.tock> (raw)
In-Reply-To: <1255293786-17293-2-git-send-email-felipe.contreras@gmail.com>

Felipe Contreras wrote:
> So that users get to know how to configure git from the get-to with good
> practical example (color.ui = auto) that most people would probably like
> anyway.
> 
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>

Good idea.  Some comments:

> +Git's configuration is distributed among different locations--this manual will
> +only to deal with 'global' (for the user) and 'repository' variables, where
> +'repository' variables take precedence over 'global' ones.

What are these different locations you speak of?  If git’s configuration
is complicated to deal with, maybe that is something that could be
improved.

This is very early in the manual, where every word counts.  I am not
very good at wording and do not have any better suggestions, but would
it be possible to more efficiently convey this:

	Git reads its per-user configuration from ~/.gitignore.

	That file can also be manipulated with the "git config"
	command, which can be convenient in scripts or when using
	operating systems like Windows where it is not clear where
	the home directory is.

	For example, if your terminal supports it, you can tell Git
	to use color in the output for commands such as "git diff"
	with "git config --global color.ui auto".

	For more information and a list of possible settings, see
	git-config(1).

By the way, this reminds me that I am not sure git-config(1) conveys the
list of configuration items in an ideal way.  It can be easy to dismiss
that page as plumbing documentation when seeing it for the first time.
Should we ship a sample .gitconfig with all items included and comments
describing them, or a separate gitconfig(5)?  Either would be easy to
generate from config.txt.

Thoughts?
Jonathan

  parent reply	other threads:[~2009-10-11 22:23 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-11 20:43 [PATCH 0/2] user-manual: reorganize the configuration steps Felipe Contreras
2009-10-11 20:43 ` [PATCH 1/2] user-manual: add global config section Felipe Contreras
2009-10-11 20:43   ` [PATCH 2/2] user-manual: simplify the user configuration Felipe Contreras
2009-10-11 22:27   ` Jonathan Nieder [this message]
2009-10-12 21:06     ` [PATCH 1/2] user-manual: add global config section Junio C Hamano
2009-10-12 12:25   ` Michael J Gruber
2009-10-12 17:09     ` Felipe Contreras
2009-10-13  7:19       ` Michael J Gruber
2009-10-14 14:26         ` Felipe Contreras
2009-10-14 16:09           ` Michael J Gruber
2009-10-14 19:10             ` Junio C Hamano
2009-10-14  2:49 ` [PATCH 0/2] user-manual: reorganize the configuration steps J. Bruce Fields
2009-10-14 14:14   ` Felipe Contreras

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=20091011222729.GA5114@progeny.tock \
    --to=jrnieder@gmail.com \
    --cc=bfields@citi.umich.edu \
    --cc=felipe.contreras@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.