procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of 'user-emacs-directory'

Browse source 
* doc/emacs/custom.texi (Find Init): Document the effect of
'user-emacs-directory' on native compilation.  Advise against
changing the value of 'user-emacs-directory' in init files.
(Bug#77745)
This commit is contained in:
Eli Zaretskii 2025-04-12 09:52:04 +03:00
parent 3f06059730
commit 6509cc20a9
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/emacs/custom.texi
View file

@ -2964,9 +2964,19 @@ Emacs will set @code{user-emacs-directory} to the directory it decides
to use. This directory is subsequently used to look for your other to use. This directory is subsequently used to look for your other
user-specific Emacs files, such as @code{custom-file} (@pxref{Saving user-specific Emacs files, such as @code{custom-file} (@pxref{Saving
Customizations}), the saved desktop (@pxref{Saving Emacs Sessions}) and Customizations}), the saved desktop (@pxref{Saving Emacs Sessions}) and
others. The @code{--init-directory} command-line option (@pxref{Initial others. It is also used to compute the value of the
Options}) overrides the value of @code{user-emacs-directory} determined @code{native-comp-eln-load-path} (@pxref{Lisp Libraries}), which is
as side effect of the search for your user init file described above. where Emacs looks for natively-compiled Lisp code and where it deposits
the newly-compiled Lisp code produced by asynchronous compilation of
packages your init files and the subsequent Emacs session load. The
@code{--init-directory} command-line option (@pxref{Initial Options})
overrides the value of @code{user-emacs-directory} determined as side
effect of the search for your user init file described above.
Since @code{user-emacs-directory}, once determined by Emacs, is used by
the rest of the startup code to locate other files and directories, we
do not recommend changing its value in your init files, as that could
disrupt or break the correct startup of your Emacs sessions.
Although this is backward-compatible with older Emacs versions, modern Although this is backward-compatible with older Emacs versions, modern
POSIX platforms prefer putting your initialization files under POSIX platforms prefer putting your initialization files under