Skip to content

Commit 5806881

Browse files
committed
Merge branch 'hw/doc-git-dir' into pu
* hw/doc-git-dir: git: update documentation for --git-dir
2 parents 2ddddc2 + d82ad54 commit 5806881

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

Documentation/git.txt

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,23 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
110110
Do not pipe Git output into a pager.
111111

112112
--git-dir=<path>::
113-
Set the path to the repository. This can also be controlled by
114-
setting the `GIT_DIR` environment variable. It can be an absolute
115-
path or relative path to current working directory.
113+
Set the path to the repository (".git" directory). This can also be
114+
controlled by setting the `GIT_DIR` environment variable. It can be
115+
an absolute path or relative path to current working directory.
116+
+
117+
Specifying the location of the ".git" directory using this
118+
option (or `GIT_DIR` environment variable) turns off the
119+
repository discovery that tries to find a directory with
120+
".git" subdirectory (which is how the repository and the
121+
top-level of the working tree are discovered), and tells Git
122+
that you are at the top level of the working tree. If you
123+
are not at the top-level directory of the working tree, you
124+
should tell Git where the top-level of the working tree is,
125+
with the `--work-tree=<path>` option (or `GIT_WORK_TREE`
126+
environment variable)
127+
+
128+
If you just want to run git as if it was started in `<path>` then use
129+
`git -C <path>`.
116130

117131
--work-tree=<path>::
118132
Set the path to the working tree. It can be an absolute path

0 commit comments

Comments
 (0)