diff options
| author | Alex Kost <alezost@gmail.com> | 2016-02-05 14:51:45 +0300 |
|---|---|---|
| committer | Alex Kost <alezost@gmail.com> | 2016-02-07 11:24:35 +0300 |
| commit | 7c1b1ae24affad95c0595830d0163cdf771ec787 (patch) | |
| tree | 1b0bb64c6117ed2bcb933fc62f92c0c9ffb98925 /doc | |
| parent | b3fee145df2a2cb310ced2e7f34e0a2b6083e661 (diff) | |
| download | guix-7c1b1ae24affad95c0595830d0163cdf771ec787.tar guix-7c1b1ae24affad95c0595830d0163cdf771ec787.tar.gz | |
doc: Document 'guix-edit' Emacs command.
* doc/emacs.texi (Emacs Commands): Document "M-x guix-edit".
* doc/guix.texi (Invoking guix edit): Mention it.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs.texi | 22 | ||||
| -rw-r--r-- | doc/guix.texi | 6 |
2 files changed, 25 insertions, 3 deletions
diff --git a/doc/emacs.texi b/doc/emacs.texi index 19dc87f177..d46c17c4a0 100644 --- a/doc/emacs.texi +++ b/doc/emacs.texi @@ -219,6 +219,28 @@ With @kbd{C-u}, make it verbose. Once @command{guix pull} has succeeded, the Guix REPL is restared. This allows you to keep using the Emacs interface with the updated Guix. +Finally, there is an Emacs variant of @command{guix edit} command +(@pxref{Invoking guix edit}): + +@table @kbd +@item M-x guix-edit +As with @kbd{M-x guix-packages-by-name}, you can press @key{TAB} to +complete a package name. +@end table + +If you are contributing to Guix, you may find it useful for @kbd{M-x +guix-edit} to open package files from your git directory. This can be +done by setting @code{guix-directory} variable. For example, after +this: + +@example +(setq guix-directory "~/src/guix") +@end example + +@kbd{M-x guix-edit guix} opens +@file{~/src/guix/gnu/packages/package-management.scm} file. + + @node Emacs General info @subsection General information diff --git a/doc/guix.texi b/doc/guix.texi index 66ab384e98..80a1621b45 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -4201,9 +4201,9 @@ launches the program specified in the @code{VISUAL} or in the and that of Vim. If you are using Emacs, note that the Emacs user interface provides -similar functionality in the ``package info'' and ``package list'' -buffers created by @kbd{M-x guix-search-by-name} and similar commands -(@pxref{Emacs Commands}). +@kbd{M-x guix-edit} command and a similar functionality in the ``package +info'' and ``package list'' buffers created by @kbd{M-x +guix-search-by-name} and similar commands (@pxref{Emacs Commands}). @node Invoking guix download |