Documentation on --git-dir and --work-tree

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 7a24f6e819ea0e5431748cea64b46369dfd6a114..824e416e9f8157d54d3f37e0e520fff5f9a125c0 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -234,7 +234,13 @@ core.worktree::
        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
        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

-       variable and the '--work-tree' command line option.
+       variable and the '--work-tree' command line option. It can be
+       a 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
+       --work-tree, GIT_WORK_TREE and core.worktree is specified,
+       the current working directory is regarded as the top directory
+       of your working tree.

 
 core.logAllRefUpdates::
        Enable the reflog. Updates to a ref <ref> is logged to the file
 
 core.logAllRefUpdates::
        Enable the reflog. Updates to a ref <ref> is logged to the file

diff --git a/Documentation/git.txt b/Documentation/git.txt
index a070e078e75389d1ea252b8f1b80bb5bc707e1aa..6f445b1e3bbefccdb865f8cb93fb470892b94e41 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -143,7 +143,8 @@ help ...'.
 
 --git-dir=<path>::
        Set the path to the repository. This can also be controlled by
 
 --git-dir=<path>::
        Set the path to the repository. This can also be controlled by

-       setting the GIT_DIR environment variable.
+       setting the GIT_DIR environment variable. It can be an absolute
+       path or relative path to current working directory.

 
 --work-tree=<path>::
        Set the path to the working tree.  The value will not be
 
 --work-tree=<path>::
        Set the path to the working tree.  The value will not be


@@ -151,7 +152,12 @@ help ...'.
        a .git directory (i.e. $GIT_DIR is not set).
        This can also be controlled by setting the GIT_WORK_TREE
        environment variable and the core.worktree configuration
        a .git directory (i.e. $GIT_DIR is not set).
        This can also be controlled by setting the GIT_WORK_TREE
        environment variable and the core.worktree configuration

-       variable.
+       variable. 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
+       --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::
        Treat the repository as a bare repository.  If GIT_DIR
 
 --bare::
        Treat the repository as a bare repository.  If GIT_DIR