Skip to content

Commit 46a1edf

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 1cbb2f2 commit 46a1edf

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
@@ -372,6 +372,14 @@ Environment Variables
372372
---------------------
373373
Various Git commands use the following environment variables:
374374

375+
System
376+
~~~~~~
377+
`HOME`::
378+
Specifies the path to the user's home directory. On Windows, if
379+
unset, Git will set a process environment variable equal to:
380+
`$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist;
381+
otherwise `$USERPROFILE` if `$USERPROFILE` exists.
382+
375383
The Git Repository
376384
~~~~~~~~~~~~~~~~~~
377385
These environment variables apply to 'all' core Git commands. Nb: it

0 commit comments

Comments
 (0)