development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-10-03 23:29:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

config doc: remove confusion about relative GIT_DIR from FILES section

Browse source 
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>
This commit is contained in:
Jonathan Nieder 2012-05-25 13:12:04 -05:00 committed by Junio C Hamano
parent c4649188e9
commit ec84e069af
1 changed files with 1 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Documentation/git-config.txt
View file

@ -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"