Skip to content

Commit dc26d18

Browse files
alejandro5042Git for Windows Build Agent
authored and
Git for Windows Build Agent
committed
Document how $HOME is set on Windows
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 <[email protected]>
1 parent bb8d51b commit dc26d18

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Documentation/git.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,14 @@ Environment Variables
408408
---------------------
409409
Various Git commands use the following environment variables:
410410

411+
System
412+
~~~~~~
413+
`HOME`::
414+
Specifies the path to the user's home directory. On Windows, if
415+
unset, Git will set a process environment variable equal to:
416+
`$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist;
417+
otherwise `$USERPROFILE` if `$USERPROFILE` exists.
418+
411419
The Git Repository
412420
~~~~~~~~~~~~~~~~~~
413421
These environment variables apply to 'all' core Git commands. Nb: it

0 commit comments

Comments
 (0)