diff options
| author | Jonathan Nieder <jrnieder@gmail.com> | 2012-05-25 13:12:04 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-05-25 11:22:02 -0700 |
| commit | ec84e069afd7845b1d6bb37d2aaefa913b0e0141 (patch) | |
| tree | e1435dcfcc0e882f732c68d8ad8f63beb6feb3d5 /Documentation/git-config.txt | |
| parent | c4649188e9140c960cec54798b153382fb4d6191 (diff) | |
| download | git-ec84e069afd7845b1d6bb37d2aaefa913b0e0141.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-config.txt')
| -rw-r--r-- | Documentation/git-config.txt | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 3f5d216a09..d9463cb387 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" |