From: Alejandro Barreto <alejandro.barreto@xxxxxx>
Git documentation refers to $HOME and $XDG_CONFIG_HOME often, but does
not specify how or where these values come from on Windows where neither
is set by default. The new documentation reflects the behavior of
setup_windows_environment() in compat/mingw.c.
Signed-off-by: Alejandro Barreto <alejandro.barreto@xxxxxx>
Signed-off-by: M Hickford <mirth.hickford@xxxxxxxxx>
---
Document how $HOME is set on Windows
CC: Alejandro Barreto alejandro.barreto@xxxxxx, Johannes Schindelin
johannes.schindelin@xxxxxx
Fixes https://github.com/git-for-windows/git/issues/5282
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1834%2Fhickford%2Fhome-docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1834/hickford/home-docs-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1834
Documentation/git.txt | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index d15a8697625..47509c9e1a3 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -477,6 +477,14 @@ their values the same way as Boolean valued configuration variables, e.g.
Here are the variables:
+System
+~~~~~~~~~~~~~~~~~~
+`HOME`::
+ Specifies the path to the user's home directory. On Windows, if
+ unset, Git will set a process environment variable equal to:
+ `$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist;
+ otherwise `$USERPROFILE` if `$USERPROFILE` exists.
+
The Git Repository
~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core Git commands. Nb: it
base-commit: cc01bad4a9f566cf4453c7edd6b433851b0835e2
--
gitgitgadget
