Document HOME environment variable
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@ni.com> Signed-off-by: M Hickford <mirth.hickford@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Alejandro Barreto committed
Dec 9, 2024 at 19:18 UTC
8525e928868757c2ebce3859dae0a9fd0f9ac9fd
1 file changed
+8
Documentation/git.txt
+8
@@ -477,6 +477,14 @@ their values the same way as Boolean valued configuration variables, e.g.
477
478
Here are the variables:
479
480
+System
481
+~~~~~~~~~~~~~~~~~~
482
+`HOME`::
483
+ Specifies the path to the user's home directory. On Windows, if
484
+ unset, Git will set a process environment variable equal to:
485
+ `$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist;
486
+ otherwise `$USERPROFILE` if `$USERPROFILE` exists.
487
+
488
The Git Repository
489
~~~~~~~~~~~~~~~~~~
490
These environment variables apply to 'all' core Git commands. Nb: it