Re: [RFC/PATCH 7/8] user-manual: add global config section

["J. Bruce Fields" <bfields@fieldses.org>]

On Sun, Mar 22, 2009 at 08:05:20PM +0200, Felipe Contreras wrote:
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> ---
>  Documentation/user-manual.txt |   34 ++++++++++++++++++++++++++++++++++
>  1 files changed, 34 insertions(+), 0 deletions(-)
> 
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index 3278aa7..b7678aa 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -40,6 +40,40 @@ without any explanation.
>  Finally, see <<todo>> for ways that you can help make this manual more
>  complete.
>  
> +[[getting-started]]
> +Getting started
> +=============
> +
> +You can skip this section safely, however, configuring git at an early stage
> +would probably make your overall experience with it more pleasant. Also many
> +parts on this manual would be easier to grasp.

I'd skip this first paragraph.

> +
> +Git's configuration is distributed on different locations: 'system', 'global', and
> +'repository'. Variables are stored in the form of 'foo.bar', and the precedence
> +order is 'repository' > 'global' > 'system'.

"distributed on" isn't right ("among" instead of "on" might work).  It's
not obvious to me what ">" means in terms of precedence.  And I'm not
sure the comment about the form conveys any useful information.  Also, I
think the systemwide configuration is less important, and could be left
to the man page.

> +
> +You would probably want to start setting up something useful:
> +------------------------------------------------
> +$ git config --global color.ui auto
> +------------------------------------------------
> +
> +This will make prettier the output of certain commands such as `git diff`, but
> +that's not important; what is important here is that `color.ui` has been
> +stored in the 'global' (for the user) configuration.
> +
> +You can take a look and manually modify the configuration with the `--edit`

"take a look and" isn't really necessary; either eliminate it or replace
it by "view and" or just "also".

> +option (will use '$EDITOR'):

s/will/which will/.

--b.

> +------------------------------------------------
> +$ git config --global --edit
> +[color]
> +        ui = auto
> +------------------------------------------------
> +
> +Or you can manually edit the file which is located in `~/.gitconfig`. Other
> +locations are `/etc/gitconfig` (system), and `.git/config` (repository).
> +
> +Other git configurations will be covered in the rest of the manual, if you
> +want to learn more look at linkgit:git-config[1] for details.
>  
>  [[repositories-and-branches]]
>  Repositories and Branches
> -- 
> 1.6.2.1.352.gae594
> 
> --
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html