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

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: Jan 25, 2009, 21:12 UTC
Message-ID: <94a0d4530901251312q4201d51btd806fe860a12afd6@mail.gmail.com>
In-Reply-To: <7vvds3dszy.fsf@gitster.siamese.dyndns.org>

On Sun, Jan 25, 2009 at 10:34 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 17 quoted lines

> Felipe Contreras <felipe.contreras@gmail.com> writes:
>
>> It's much easier for everyone to just use git config --global than
>> explain how create and edit the .gitconfig file. If this is explained
>> it shouldn't be in the "Telling git your name" section.
>
> I think it is Ok to have, and it probably is helpful to have, a document
> that accompanies the generic manual, "Platform supplement", to explain
> things like "On this platform, what is referred to as $HOME in the generic
> manual is implemented as %HOMEDRIVE%%HOMEPATH%", to cover peculiarities of
> each platform.
>
> But I think it is going backwards to butcher the description in the main
> manual in order to make the platform supplement shorter.  Even Windows is
> not a good enough reason to break the logical ordering of how things
> should be best taught to the readers of the manual, which is not specific
> to a platform.

That's why I think there should be a whole section regarding git configuration before "Telling git your name".

However, my last proposal was to have both the git config --global *and* the $HOME/.gitconfig description. Is there any argument against that?

-- 
Felipe Contreras