undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation updates for 'GIT_WORK_TREE without GIT_DIR' historical usecase

Browse Source 
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano 2011-01-23 15:49:41 -08:00
parent 4868b2ea17
commit ea472c1e35
2 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Documentation/config.txt
View File

@ -317,17 +317,26 @@ false), while all other repositories are assumed to be bare (bare
= true). = true).
core.worktree:: core.worktree::
Set the path to the working tree. The value will not be Set the path to the root of the working tree.
used in combination with repositories found automatically in
a .git directory (i.e. $GIT_DIR is not set).
This can be overridden by the GIT_WORK_TREE environment This can be overridden by the GIT_WORK_TREE environment
variable and the '--work-tree' command line option. It can be variable and the '--work-tree' command line option.
an absolute path or relative path to the directory specified by The value can an absolute path or relative to the path to
--git-dir or GIT_DIR. the .git directory, which is either specified by --git-dir
Note: If --git-dir or GIT_DIR are specified but none of or GIT_DIR, or automatically discovered.
If --git-dir or GIT_DIR is specified but none of
--work-tree, GIT_WORK_TREE and core.worktree is specified, --work-tree, GIT_WORK_TREE and core.worktree is specified,
the current working directory is regarded as the top directory the current working directory is regarded as the top level
of your working tree. of your working tree.
+
Note that this variable is honored even when set in a configuration
file in a ".git" subdirectory of a directory and its value differs
from the latter directory (e.g. "/path/to/.git/config" has
core.worktree set to "/different/path"), which is most likely a
misconfiguration. Running git commands in the "/path/to" directory will
still use "/different/path" as the root of the work tree and can cause
confusion unless you know what you are doing (e.g. you are creating a
read-only snapshot of the same index to a location different from the
repository's usual working tree).
core.logAllRefUpdates:: core.logAllRefUpdates::
Enable the reflog. Updates to a ref <ref> is logged to the file Enable the reflog. Updates to a ref <ref> is logged to the file

13
Documentation/git.txt
View File

@ -291,17 +291,12 @@ help ...`.
path or relative path to current working directory. path or relative path to current working directory.
--work-tree=<path>:: --work-tree=<path>::
Set the path to the working tree. The value will not be Set the path to the working tree. It can be an absolute path
used in combination with repositories found automatically in or a path relative to the current working directory.
a .git directory (i.e. $GIT_DIR is not set).
This can also be controlled by setting the GIT_WORK_TREE This can also be controlled by setting the GIT_WORK_TREE
environment variable and the core.worktree configuration environment variable and the core.worktree configuration
variable. It can be an absolute path or relative path to variable (see core.worktree in linkgit:git-config[1] for a
current working directory. more detailed discussion).
Note: If --git-dir or GIT_DIR are specified but none of
--work-tree, GIT_WORK_TREE and core.worktree is specified,
the current working directory is regarded as the top directory
of your working tree.
--bare:: --bare::
Treat the repository as a bare repository. If GIT_DIR Treat the repository as a bare repository. If GIT_DIR