diff options
author | Alex Kost <alezost@gmail.com> | 2016-03-05 11:39:35 +0300 |
---|---|---|
committer | Alex Kost <alezost@gmail.com> | 2016-03-24 18:49:59 +0300 |
commit | 6667af6a97dc544ae4c9041702b434ab1cf49677 (patch) | |
tree | 2e7d8eb7c32c0268254fe0c9f4b2c74fc8721407 | |
parent | ff4455e6e225ab6f12d6d8e015f403a6090ed1b8 (diff) | |
download | guix-6667af6a97dc544ae4c9041702b434ab1cf49677.tar guix-6667af6a97dc544ae4c9041702b434ab1cf49677.tar.gz |
doc: Clarify installation instructions for "guix.el".
* doc/emacs.texi (Emacs Initial Setup): Mention that "guix package -i
guix" is an easy way. Warn that "make install" may lead to an outdated
code.
-rw-r--r-- | doc/emacs.texi | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/emacs.texi b/doc/emacs.texi index 527afe7806..c4fdfff272 100644 --- a/doc/emacs.texi +++ b/doc/emacs.texi @@ -49,7 +49,13 @@ command (@pxref{Emacs Popup Interface}). @end itemize When it is done, ``guix.el'' may be configured by requiring -@code{guix-autoloads} file---i.e., by adding the following code into +@code{guix-autoloads} file. If you install Guix in your user profile, +this auto-loading is done automatically by our Emacs package +(@pxref{Application Setup}), so a universal recipe for configuring +``guix.el'' is: @command{guix package -i guix}. If you do this, there +is no need to read further. + +For the manual installation, you need to add the following code into your init file (@pxref{Init File,,, emacs, The GNU Emacs Manual}): @example @@ -66,18 +72,19 @@ If it was installed by a package manager of your distribution or by a usual @code{./configure && make && make install} command sequence, then elisp files are placed in a standard directory with Emacs packages (usually it is @file{/usr/share/emacs/site-lisp/}), which is already in -@code{load-path}, so there is no need to add that directory there. +@code{load-path}, so there is no need to add that directory there. Note +that if you don't update this installation periodically, you may get an +outdated Emacs code which does not work with the current Guile code of +Guix. @item If you used a binary installation method (@pxref{Binary Installation}), then Guix is installed somewhere in the store, so the elisp files are placed in @file{/gnu/store/@dots{}-guix-0.8.2/share/emacs/site-lisp/} or alike. However it is not recommended to refer directly to a store -directory. Instead you can install Guix using Guix itself with -@command{guix package -i guix} command (@pxref{Invoking guix package}). -No further actions are needed in this case, as @code{guix-autoloads} -file will automatically be loaded by Emacs (if it is installed with -Guix, of course) (@pxref{Application Setup}). +directory, as it may be garbage-collected one day. So a better choice +would be to install Guix using Guix itself with @command{guix package -i +guix}. @item If you did not install Guix at all and prefer a hacking way |