aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Barreto <alejandro.barreto@ni.com>2024-12-09 19:18:14 +0000
committerJunio C Hamano <gitster@pobox.com>2024-12-10 08:47:55 +0900
commit8525e928868757c2ebce3859dae0a9fd0f9ac9fd (patch)
treeaae825d5530fd33342c290ba7eabebbf36117d5a
parentGit 2.47.1 (diff)
downloadgit-8525e928868757c2ebce3859dae0a9fd0f9ac9fd.tar.gz
git-8525e928868757c2ebce3859dae0a9fd0f9ac9fd.zip
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>
-rw-r--r--Documentation/git.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index d15a869762..47509c9e1a 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -477,6 +477,14 @@ their values the same way as Boolean valued configuration variables, e.g.
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
~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core Git commands. Nb: it