]> git.ipfire.org Git - thirdparty/git.git/commit
git: update documentation for --git-dir
authorHeba Waly <heba.waly@gmail.com>
Thu, 30 Jan 2020 01:14:01 +0000 (01:14 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 30 Jan 2020 18:25:00 +0000 (10:25 -0800)
commitd82ad54945be557f9c70550842ffc568b25cd16a
treecfdb8fb0c3768d725a2b9aa923f1225d81a74edb
parentc7a62075917b3340f908093f63f1161c44ed1475
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>
Documentation/git.txt