diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2019-08-31 18:16:17 -0700 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2019-08-31 18:17:57 -0700 |
| commit | 72ab46fefcc8fa2b20204eaa79e1d750e56d8ccf (patch) | |
| tree | 1c3e1d4af4139d5de0375daee45c63659a2365a6 /doc/lispref/os.texi | |
| parent | 02a74ed315ab0a69a098a2a1c4687c0c9a644e75 (diff) | |
| download | emacs-72ab46fefcc8fa2b20204eaa79e1d750e56d8ccf.tar.gz | |
Improve documentation for recent XDG-related changes
Adjust documentation in the light of Eli’s review here:
https://lists.gnu.org/r/emacs-devel/2019-07/msg00712.html
* doc/emacs/custom.texi (Init File, Find Init):
* doc/lispref/files.texi (Standard File Names):
* doc/lispref/os.texi (Init File):
Diffstat (limited to 'doc/lispref/os.texi')
| -rw-r--r-- | doc/lispref/os.texi | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index df212569087..c94e96bde82 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -474,10 +474,13 @@ the value refers to the corresponding source file. @defvar user-emacs-directory This variable holds the name of the Emacs default directory. -It is @file{@var{xdghome}/emacs/} if that directory exists, otherwise -@file{~/.emacs.d/} on all platforms but MS-DOS. Here, @var{xdghome} +It defaults to @file{$@{XDG_CONFIG_HOME-'~/.config'@}/emacs/} +if that directory exists and @file{~/.emacs.d/} does not exist, +otherwise to @file{~/.emacs.d/} on all platforms but MS-DOS@. +Here, @file{$@{XDG_CONFIG_HOME-'~/.config'@}} stands for the value of the environment variable @env{XDG_CONFIG_HOME} if that variable is set, and for @file{~/.config} otherwise. +@xref{Find Init,,How Emacs Finds Your Init File, emacs, The GNU Emacs Manual}. @end defvar @node Terminal-Specific |