development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-09-13 21:34:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'hw/doc-git-dir'

Browse source 
One effect of specifying where the GIT_DIR is (either with the
environment variable, or with the "git --git-dir=<where> cmd"
option) is to disable the repository discovery.  This has been
placed a bit more stress in the documentation, as new users often
get confused.

* hw/doc-git-dir:
  git: update documentation for --git-dir
This commit is contained in:
Junio C Hamano 2020-02-12 12:41:36 -08:00
parent 4cf7f48891 d82ad54945
commit 17e4a1b141
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. Do not pipe Git output into a pager.
--git-dir=<path>:: --git-dir=<path>::
Set the path to the repository. This can also be controlled by Set the path to the repository (".git" directory). This can also be
setting the `GIT_DIR` environment variable. It can be an absolute controlled by setting the `GIT_DIR` environment variable. It can be
path or relative path to current working directory. 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>:: --work-tree=<path>::
Set the path to the working tree. It can be an absolute path Set the path to the working tree. It can be an absolute path