Browse Source

Documentation: always respect core.worktree if set

The value of core.worktree in a ".git/config" is honored even when it
differs from the directory that has the ".git" directory as its
subdirectory.  This is likely to be a misconfiguration, so warn users
about it.  Also, drop the part of the documentation that incorrectly
claimed that we ignore such a misconfigured value.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Nguyễn Thái Ngọc Duy 15 years ago committed by Junio C Hamano
parent
commit
f5e025a9d5
  1. 23
      Documentation/config.txt

23
Documentation/config.txt

@ -297,17 +297,24 @@ 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 work 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. It can be
a absolute path or relative path to the directory specified by an absolute path or a relative path to the .git directory,
--git-dir or GIT_DIR. either specified by --git-dir or GIT_DIR, or automatically
Note: If --git-dir or GIT_DIR are specified but none of discovered.
If --git-dir or GIT_DIR are 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 root of the
of your working tree. work 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 "/path/to" directory will
still use "/different/path" as the root of the work tree and can cause
great confusion to the users.


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

Loading…
Cancel
Save