[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 4/6] doc: emacs: Add "Locations" section.
From: |
Alex Kost |
Subject: |
[PATCH 4/6] doc: emacs: Add "Locations" section. |
Date: |
Mon, 4 Apr 2016 22:47:44 +0300 |
* doc/emacs.texi (Emacs Commands): Move description of 'guix-edit'
command to...
(Emacs Locations): ... here. Document 'guix-find-location'. New
section.
* doc/guix.texi (Top): Add it.
---
doc/emacs.texi | 63 ++++++++++++++++++++++++++++++++++++----------------------
doc/guix.texi | 1 +
2 files changed, 40 insertions(+), 24 deletions(-)
diff --git a/doc/emacs.texi b/doc/emacs.texi
index 16ff4d5..5a5fbc2 100644
--- a/doc/emacs.texi
+++ b/doc/emacs.texi
@@ -10,6 +10,7 @@ Guix convenient and fun.
* Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}.
* Package Management: Emacs Package Management. Managing packages and
generations.
* Licenses: Emacs Licenses. Interface for licenses of Guix packages.
+* Locations: Emacs Locations. Interface for package locations.
* Popup Interface: Emacs Popup Interface. Magit-like interface for guix
commands.
* Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}}
file names.
* Build Log Mode: Emacs Build Log. Highlighting Guix build logs.
@@ -220,30 +221,6 @@ 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}):
-
address@hidden @kbd
address@hidden M-x guix-edit
-As with @kbd{M-x guix-packages-by-name}, you can press @key{TAB} to
-complete a package name.
address@hidden 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:
-
address@hidden
-(setq guix-directory "~/src/guix")
address@hidden example
-
address@hidden guix-edit guix} opens
address@hidden/src/guix/gnu/packages/package-management.scm} file.
-
-Also you can use @kbd{C-u} prefix argument to specify a directory just
-for the current @kbd{M-x guix-edit} command.
-
@node Emacs General info
@subsection General information
@@ -568,6 +545,44 @@ guix-packages-by-license} would do (@pxref{Emacs
Commands}).
@end table
address@hidden Emacs Locations
address@hidden Locations
+
+As you know, package definitions are placed in Guile files, also known
+as @dfn{package locations}. The following commands should help you not
+getting lost in these locations:
+
address@hidden @kbd
+
address@hidden M-x guix-find-location
+Find package location file (press @key{TAB} to choose a location from a
+completion list).
+
address@hidden M-x guix-edit
+Find location of a specified package. This is an Emacs analog of
address@hidden edit} command (@pxref{Invoking guix edit}). As with
address@hidden guix-packages-by-name}, you can press @key{TAB} to complete a
+package name.
+
address@hidden table
+
+If you are contributing to Guix, you may find it useful for @kbd{M-x
+guix-find-location} and @kbd{M-x guix-edit} to open locations from your
+git directory. This can be done by setting @code{guix-directory}
+variable. For example, after this:
+
address@hidden
+(setq guix-directory "~/src/guix")
address@hidden example
+
address@hidden guix-edit guix} opens
address@hidden/src/guix/gnu/packages/package-management.scm} file.
+
+Also you can use @kbd{C-u} prefix argument to specify a directory just
+for the current @kbd{M-x guix-find-location} or @kbd{M-x guix-edit}
+command.
+
+
@node Emacs Popup Interface
@section Popup Interface
diff --git a/doc/guix.texi b/doc/guix.texi
index a34d547..710adbd 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -118,6 +118,7 @@ Emacs Interface
* Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}.
* Package Management: Emacs Package Management. Managing packages and
generations.
* Licenses: Emacs Licenses. Interface for licenses of Guix packages.
+* Locations: Emacs Locations. Interface for package locations.
* Popup Interface: Emacs Popup Interface. Magit-like interface for guix
commands.
* Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}}
file names.
* Build Log Mode: Emacs Build Log. Highlighting Guix build logs.
--
2.7.3
- Re: [PATCH 3/6] emacs: Make 'guix-find-location' interactive., (continued)
- [PATCH 2/6] emacs: Separate package location code., Alex Kost, 2016/04/04
- [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Alex Kost, 2016/04/04
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Ludovic Courtès, 2016/04/05
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Alex Kost, 2016/04/06
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Ludovic Courtès, 2016/04/15
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Alex Kost, 2016/04/17
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Ludovic Courtès, 2016/04/17
- Re: [PATCH 1/6] emacs: Add 'guix-packages-by-location' command., Alex Kost, 2016/04/18
[PATCH 4/6] doc: emacs: Add "Locations" section.,
Alex Kost <=
[PATCH 5/6] emacs: Add interface for package locations., Alex Kost, 2016/04/04
[PATCH 6/6] emacs: Add license/location "Packages" buttons to Info buffer., Alex Kost, 2016/04/04