[PATCH] config doc: remove confusion about relative GIT_DIR from FILES section
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- May 25, 2012, 18:12 UTC
- Message-ID
- <20120525181204.GA4491@burratino>
- In-Reply-To
- <CAE1pOi3qSEY=Dj-Fqj+=anULVmCdsm72_k+B0SpdGiCO3u7L9A@mail.gmail.com>
From the FILES section of the git-config(1) manual:
$GIT_DIR/config:: Repository specific configuration file. (The filename is of course relative to the repository root, not the working directory.)
That's confusing because $GIT_DIR really is relative to the working directory.
$ GIT_DIR=.git GIT_EDITOR='pwd; echo editing' $ export GIT_DIR GIT_EDITOR $ git config --edit --local /home/jrn/src/git/Documentation editing .git/config
It turns out that the comment is a remnant from older days when the heading said ".git/config" (which is indeed relative to the top of the worktree).
It was only when the heading was changed to refer more precisely to <git dir>/config (see v1.5.3.2~18, AsciiDoc tweak to avoid leading dot, 2007-09-14) that the parenthesis stopped making sense. Remove it.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> --- Hilco Wijbenga wrote:
> On 25 May 2012 10:42, Jonathan Nieder <jrnieder@gmail.com> wrote:
Show 5 quoted lines
>> Regarding $GIT_DIR/config, it says "The filename is of course relative >> to the repository root, not the working directory.". Is this out of >> date? (Cc-ing Peff and Duy.) > > I'm sure it's not.
You're right --- the current wording never made sense and is not an example of accurate documentation going stale with later behavior changes as I had suspected. Sorry for the noise.
Thanks, Jonathan
Documentation/git-config.txt | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 3f5d216a..d9463cb3 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -198,9 +198,7 @@ If not set explicitly with '--file', there are three files where 'git config' will search for configuration options: $GIT_DIR/config:: - Repository specific configuration file. (The filename is - of course relative to the repository root, not the working - directory.) + Repository specific configuration file. ~/.gitconfig:: User-specific configuration file. Also called "global"
-- 1.7.10