gitmodules.txt: fix 'GIT_WORK_TREE' variable name
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Sun, 3 Jan 2021 17:42:15 +0000 (17:42 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 4 Jan 2021 19:29:36 +0000 (11:29 -0800)
commit1f4e9319c7ce25efbb4e8469eff11c53dd079318
treefc0f9ca41d0b38be578e47873de4f14e6799e146
parent898f80736c75878acc02dc55672317fcc0e0a5a6
gitmodules.txt: fix 'GIT_WORK_TREE' variable name

'gitmodules.txt' is a guide about the '.gitmodules' file that describes
submodule properties, and that file must exist at the root of the
repository. This was clarified in e5b5c1d2cf (Document clarification:
gitmodules, gitattributes, 2008-08-31).

However, that commit mistakenly uses the non-existing environment
variable 'GIT_WORK_DIR' to refer to the root of the repository.

Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the
opportunity to modernize and improve the formatting of that guide,
and fix a grammar mistake.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Acked-by: Martin Ă…gren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitmodules.txt