Skip to content

Commit

Permalink
Documentation updates for 'GIT_WORK_TREE without GIT_DIR' historical …
Browse files Browse the repository at this point in the history
…usecase

Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Junio C Hamano committed Jan 24, 2011
1 parent 4868b2e commit ea472c1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 17 deletions.
25 changes: 17 additions & 8 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -317,17 +317,26 @@ false), while all other repositories are assumed to be bare (bare
= true).

core.worktree::
Set the path to the working tree. The value will not be
used in combination with repositories found automatically in
a .git directory (i.e. $GIT_DIR is not set).
Set the path to the root of the working tree.
This can be overridden by the GIT_WORK_TREE environment
variable and the '--work-tree' command line option. It can be
an absolute path or relative path to the directory specified by
--git-dir or GIT_DIR.
Note: If --git-dir or GIT_DIR are specified but none of
variable and the '--work-tree' command line option.
The value can an absolute path or relative to the path to
the .git directory, which is either specified by --git-dir
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,
the current working directory is regarded as the top directory
the current working directory is regarded as the top level
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::
Enable the reflog. Updates to a ref <ref> is logged to the file
Expand Down
13 changes: 4 additions & 9 deletions Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -291,17 +291,12 @@ help ...`.
path or relative path to current working directory.

--work-tree=<path>::
Set the path to the working tree. The value will not be
used in combination with repositories found automatically in
a .git directory (i.e. $GIT_DIR is not set).
Set the path to the working tree. It can be an absolute path
or a path relative to the current working directory.
This can also be controlled by setting the GIT_WORK_TREE
environment variable and the core.worktree configuration
variable. It can be an absolute path or relative path to
current working directory.
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.
variable (see core.worktree in linkgit:git-config[1] for a
more detailed discussion).

--bare::
Treat the repository as a bare repository. If GIT_DIR
Expand Down

0 comments on commit ea472c1

Please sign in to comment.