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 <alejandro.barreto@ni.com>
This commit is contained in:
Alejandro Barreto 2018-03-09 14:17:54 -06:00 коммит произвёл Matthew John Cheetham
Родитель 06bae2d293
Коммит d605866ca9
1 изменённых файлов: 8 добавлений и 0 удалений

Просмотреть файл

@ -464,6 +464,14 @@ their values the same way as Boolean valued configuration variables, e.g.
Here are the variables: 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 The Git Repository
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core Git commands. Nb: it These environment variables apply to 'all' core Git commands. Nb: it