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

From: Wincent Colaiuta <win@wincent.com>
Date: Jan 21, 2009, 21:13 UTC
Message-ID: <8C518E90-A7AE-48F0-A1A3-F333B21F468E@wincent.com>
In-Reply-To: <7v8wp4e5wn.fsf@gitster.siamese.dyndns.org>

El 21/1/2009, a las 21:54, Junio C Hamano escribió:

Show 16 quoted lines

> Felipe Contreras <felipe.contreras@gmail.com> writes:
>
>> 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 am moderately against changing this part to use "git config".
>
> We traditionally introduced how to set configuration variables first  
> by
> editing it in an editor, and this was quite deliberate, in order to  
> show
> how the configuration file looks like, to demonstrate that there is no
> deep magic in the file format, and to explain that it is perfectly  
> Ok to
> edit it without using "git config" command.

If that's the goal, why not do both?:

1. Show people how to use "git config" like this patch does (seeing as  
it's easier and less error prone)

2. Tell people that they can inspect and even edit the config file by  
hand if they want

The actual order of 1 and 2 depends on where you want to place more emphasis:

Something like either:

Show 15 quoted lines

> Before creating any commits, you should introduce yourself to git.   
> The
> easiest way to do so is to make sure the following lines appear in a
> file named .gitconfig in your home directory:
>
> [user]
> 	name = Your Name Comes Here
> 	email = you@yourdomain.example.com
>
> As a convenience you can use linkgit:git-config[1] to modify  
> your .gitconfig
> instead of editing it by hand:
>
> $ git config --global user.name "Your Name Comes Here"
> $ git config --global user.email you@yourdomain.example.com

Or:

Show 14 quoted lines

> Before creating any commits, you should introduce yourself to git.   
> The
> easiest way is to use the linkgit:git-config[1] command:
>
> $ git config --global user.name "Your Name Comes Here"
> $ git config --global user.email you@yourdomain.example.com
>
> Your settings are written to a file named .gitconfig in your home
> directory which you can inspect or even edit by hand. Settings look  
> like this:
>
> [user]
> 	name = Your Name Comes Here
> 	email = you@yourdomain.example.com

Cheers, Wincent