From: Todd Zullinger <tmz@pobox.com>
To: Jacob Keller <jacob.keller@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: clarify usage of XDG_CONFIG_HOME config file
Date: Tue, 12 Dec 2017 10:20:09 -0500 [thread overview]
Message-ID: <20171212152009.GS3693@zaya.teonanacatl.net> (raw)
In-Reply-To: <1513077862-165-1-git-send-email-jacob.keller@gmail.com>
Hi Jacob,
Jacob Keller wrote:
> The documentation for git config and how it reads the user specific
> configuration file is misleading. In some places it implies that
> $XDG_CONFIG_HOME/git/config will always be read. In others, it implies
> that only one of ~/.gitconfig and $XDG_CONFIG_HOME/git/config will be
> read.
>
> Improve the documentation explaining how the various configuration files
> are read, and combined.
>
> Instead of referencing each file individually, reference each type of
> location git will check. When discussing the user configuration, explain
> how we switch between one of three choices. Ensure to note that only one
> of the three choices is used.
Perhaps it would read a little easier as "Make it clear ..."
rather than "Ensure to note that ..." ?
> +Note that git will only ever use one of these files as the global user
> +configuration file at once. Additionally if you sometimes use an older version
> +of git, it is best to only rely on `~/.gitconfig` as support for the others was
> +added fairly recently.
Is it really accurate to say these were added fairly
recently? It looks like XDG_CONFIG_HOME was added in
21cf322791 ("config: read (but not write) from
$XDG_CONFIG_HOME/git/config file", 2012-06-22) and
0e8593dc5b ("config: write to $XDG_CONFIG_HOME/git/config
file when appropriate", 2012-06-22) which are in 1.7.12.
Would it be better to say something like "if you sometimes
use a version of git prior to 1.7.12" here?
Or maybe we can drop "Additionally ..." altogether now?
Someone using a 5 year old git version sometimes will
hopefully know to check the documentation for that older
version.
--
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now don't say you can't swear off drinking; it's easy. I've done it a
thousand times.
-- W.C. Fields
next prev parent reply other threads:[~2017-12-12 15:20 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-12 11:24 [PATCH] doc: clarify usage of XDG_CONFIG_HOME config file Jacob Keller
2017-12-12 15:20 ` Todd Zullinger [this message]
2017-12-13 5:36 ` Jacob Keller
2017-12-12 19:47 ` Junio C Hamano
2017-12-13 5:38 ` Jacob Keller
2017-12-13 14:23 ` Yaroslav Halchenko
2017-12-13 19:57 ` Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171212152009.GS3693@zaya.teonanacatl.net \
--to=tmz@pobox.com \
--cc=git@vger.kernel.org \
--cc=jacob.keller@gmail.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).