mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-09 07:06:12 +02:00
Code

git: update documentation for --git-dir 

git --git-dir <path> is a bit confusing and sometimes doesn't work as
the user would expect it to.

For example, if the user runs `git --git-dir=<path> status`, git
will skip the repository discovery algorithm and will assign the
work tree to the user's current work directory unless otherwise
specified. When this assignment is wrong, the output will not match
the user's expectations.

This patch updates the documentation to make it clearer.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Heba Waly 2020-01-30 01:14:01 +00:00 committed by Junio C Hamano
parent c7a6207591
commit d82ad54945
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/git.txt
View File

@ -110,9 +110,23 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
Do not pipe Git output into a pager.
--git-dir=<path>::
Set the path to the repository. This can also be controlled by
setting the `GIT_DIR` environment variable. It can be an absolute
path or relative path to current working directory.
Set the path to the repository (".git" directory). This can also be
controlled by setting the `GIT_DIR` environment variable. It can be
an absolute path or relative path to current working directory.
+
Specifying the location of the ".git" directory using this
option (or `GIT_DIR` environment variable) turns off the
repository discovery that tries to find a directory with
".git" subdirectory (which is how the repository and the
top-level of the working tree are discovered), and tells Git
that you are at the top level of the working tree. If you
are not at the top-level directory of the working tree, you
should tell Git where the top-level of the working tree is,
with the `--work-tree=<path>` option (or `GIT_WORK_TREE`
environment variable)
+
If you just want to run git as if it was started in `<path>` then use
`git -C <path>`.
--work-tree=<path>::
Set the path to the working tree. It can be an absolute path