diff mbox series

[bug#39877] Cleanup remaining guix.d/ Emacs packages, update doc

Message ID 87h7z6kyc7.fsf@gmail.com
State Accepted
Headers show
Series [bug#39877] Cleanup remaining guix.d/ Emacs packages, update doc | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch fail View Laminar job

Commit Message

Maxim Cournoyer March 3, 2020, 1:43 a.m. UTC
Hello,

The attached patches correct the last Emacs packages that were still
using the previous guix.d/ installation prefix, as well as the
documentation.

Thank you!

Maxim

Comments

Maxim Cournoyer March 19, 2020, 5:06 p.m. UTC | #1
Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:

> Hello,
>
> The attached patches correct the last Emacs packages that were still
> using the previous guix.d/ installation prefix, as well as the
> documentation.
>
> Thank you!
>
> Maxim

Pushed to master with commit fdffceeb0199b95e6d30a5a0cb36ca0b2ed5187d;
closing.

Maxim
diff mbox series

Patch

From ca4a4d0effeca9046523b568ed79dd115e982fa9 Mon Sep 17 00:00:00 2001
From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Date: Sun, 1 Mar 2020 23:04:00 -0500
Subject: [PATCH 8/8] doc: Update to reflect the current installation prefix of
 Emacs packages.

* doc/guix.texi (Application Setup)[Emacs Packages]: No longer mention the
guix.d Elisp installation prefix.  Do not treat the user profile specially, as
it is not special anymore.
(Build Systems): Document the correct Elisp installation prefix.
---
 doc/guix.texi | 33 ++++++++++++++-------------------
 1 file changed, 14 insertions(+), 19 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index a66bb3d646..4371fbe0e1 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1737,22 +1737,18 @@  information.
 @subsection Emacs Packages
 
 @cindex @code{emacs}
-When you install Emacs packages with Guix, the elisp files may be placed
-either in @file{$HOME/.guix-profile/share/emacs/site-lisp/} or in
-sub-directories of
-@file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/}.  The latter
-directory exists because potentially there may exist thousands of Emacs
-packages and storing all their files in a single directory may not be
-reliable (because of name conflicts).  So we think using a separate
-directory for each package is a good idea.  It is very similar to how
-the Emacs package system organizes the file structure (@pxref{Package
-Files,,, emacs, The GNU Emacs Manual}).
-
-By default, Emacs (installed with Guix) ``knows'' where these packages
-are placed, so you do not need to perform any configuration.  If, for
-some reason, you want to avoid auto-loading Emacs packages installed
-with Guix, you can do so by running Emacs with @code{--no-site-file}
-option (@pxref{Init File,,, emacs, The GNU Emacs Manual}).
+When you install Emacs packages with Guix, the Elisp files are placed
+under the @file{share/emacs/site-lisp/} directory of the profile in
+which they are installed.  The Elisp libraries are made available to
+Emacs through the @code{EMACSLOADPATH} environment variable, which is
+set when installing Emacs itself.
+
+Additionally, autoload definitions are automatically evaluated at the
+initialization of Emacs, by the Guix-specific
+@code{guix-emacs-autoload-packages} procedure.  If, for some reason, you
+want to avoid auto-loading the Emacs packages installed with Guix, you
+can do so by running Emacs with the @code{--no-site-file} option
+(@pxref{Init File,,, emacs, The GNU Emacs Manual}).
 
 @subsection The GCC toolchain
 
@@ -6680,9 +6676,8 @@  of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual}).
 It first creates the @code{@code{package}-autoloads.el} file, then it
 byte compiles all Emacs Lisp files.  Differently from the Emacs
 packaging system, the Info documentation files are moved to the standard
-documentation directory and the @file{dir} file is deleted.  Each
-package is installed in its own directory under
-@file{share/emacs/site-lisp/guix.d}.
+documentation directory and the @file{dir} file is deleted.  The Elisp
+package files are installed directly under @file{share/emacs/site-lisp}.
 @end defvr
 
 @defvr {Scheme Variable} font-build-system
-- 
2.25.0