nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Alex Kost 2016-03-05 11:39:35 +03:00
parent ff4455e6e2
commit 6667af6a97
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/emacs.texi
View File

@ -49,7 +49,13 @@ command (@pxref{Emacs Popup Interface}).
@end itemize @end itemize
When it is done, ``guix.el'' may be configured by requiring 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}): your init file (@pxref{Init File,,, emacs, The GNU Emacs Manual}):
@example @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 usual @code{./configure && make && make install} command sequence, then
elisp files are placed in a standard directory with Emacs packages elisp files are placed in a standard directory with Emacs packages
(usually it is @file{/usr/share/emacs/site-lisp/}), which is already in (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 @item
If you used a binary installation method (@pxref{Binary Installation}), If you used a binary installation method (@pxref{Binary Installation}),
then Guix is installed somewhere in the store, so the elisp files are 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 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 alike. However it is not recommended to refer directly to a store
directory. Instead you can install Guix using Guix itself with directory, as it may be garbage-collected one day. So a better choice
@command{guix package -i guix} command (@pxref{Invoking guix package}). would be to install Guix using Guix itself with @command{guix package -i
No further actions are needed in this case, as @code{guix-autoloads} guix}.
file will automatically be loaded by Emacs (if it is installed with
Guix, of course) (@pxref{Application Setup}).
@item @item
If you did not install Guix at all and prefer a hacking way If you did not install Guix at all and prefer a hacking way