config doc: remove confusion about relative GIT_DIR from FILES section
authorJonathan Nieder <jrnieder@gmail.com>
Fri, 25 May 2012 18:12:04 +0000 (13:12 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 25 May 2012 18:22:02 +0000 (11:22 -0700)
commitec84e069afd7845b1d6bb37d2aaefa913b0e0141
treee1435dcfcc0e882f732c68d8ad8f63beb6feb3d5
parentc4649188e9140c960cec54798b153382fb4d6191
config doc: remove confusion about relative GIT_DIR from FILES section

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.txt