Skip to content

Commit eed670b

Browse files
alejandro5042dscho
authored andcommitted
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 69f3ad6 commit eed670b

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
@@ -437,6 +437,14 @@ Environment Variables
437437
---------------------
438438
Various Git commands use the following environment variables:
439439

440+
System
441+
~~~~~~
442+
`HOME`::
443+
Specifies the path to the user's home directory. On Windows, if
444+
unset, Git will set a process environment variable equal to:
445+
`$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist;
446+
otherwise `$USERPROFILE` if `$USERPROFILE` exists.
447+
440448
The Git Repository
441449
~~~~~~~~~~~~~~~~~~
442450
These environment variables apply to 'all' core Git commands. Nb: it

0 commit comments

Comments
 (0)