Re: [PATCH] user-manual: Simplify the user configuration.

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: Jan 21, 2009, 19:39 UTC
Message-ID: <94a0d4530901211139x6296a48m14aa7ce1d8e65145@mail.gmail.com>
In-Reply-To: <20090121191808.GF21686@coredump.intra.peff.net>

On Wed, Jan 21, 2009 at 9:18 PM, Jeff King <peff@peff.net> wrote:

Show 15 quoted lines

> On Wed, Jan 21, 2009 at 09:04:10PM +0200, Felipe Contreras wrote:
>
>> This is shorter, avoids the burder to think about the format of the
>> configuration file, and git config is already used in other places in
>> the manual.
>
> I seem to recall this coming up several times before, and there being a
> sentiment that it was _good_ to introduce the user to concept of a
> config file. It lets them know that it exists, approximately what the
> syntax looks like, and demystifies what is going on when you type "git
> config" (i.e., it intentionally shows that there is more than way to do
> it).
>
> I don't have a personal preference, but you may want to grep the
> list archives for other discussion.

That's over complicating the user with what should probably be one of the first things to do. Besides, do Windows users know which is their home directory?

Maybe a comment like previous git config commands: If you examine the file .gitconfig in your home directory, you will see this:

------------------------------------------------
...
[user]
       name = Your Name Comes Here
       email = you@yourdomain.example.com
...
------------------------------------------------

-- 
Felipe Contreras