diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2020-02-12 12:41:36 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-02-12 12:41:36 -0800 |
| commit | 17e4a1b141a4174955dd19131094c3c1cdeb5a8d (patch) | |
| tree | 64a70227b2cb6e7ebdd6d974ad611718d2a42c64 | |
| parent | Merge branch 'jk/push-default-doc' (diff) | |
| parent | git: update documentation for --git-dir (diff) | |
| download | tgif-17e4a1b141a4174955dd19131094c3c1cdeb5a8d.tar.xz | |
Merge branch 'hw/doc-git-dir'
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
| -rw-r--r-- | Documentation/git.txt | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt index 0093c647bf..b0672bd806 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -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 |