Alex Kost <[email protected]> skribis:
> I've just pushed a manual for “guix.el” (into “emacs-ui” branch). I
> tried my best, but I'm not a native English speaker and I have never
> worked with Texinfo before, so there may be... issues :-)
Looks good to me! Here are some minor comments (I’m not a native
speaker either):
+GNU Guix is distributed with a user interface for GNU Emacs (which is
+also known as ``guix.el''). It can be used for:
To make the goal clearer, what about something like:
GNU Guix comes with a visual user interface for GNU@tie{}Emacs, known
as ``guix.el''. It can be used for routine package management tasks,
pretty much like the @command{guix package} command (@pxref{Invoking
guix package}). Specifically, guix.el makes it easy to:
@itemize
@item browse and display ...
@item search ...
...
Also there are a few places that mention “Guix packages”, where it
should be just “packages”, I think.
+@menu
+* Initial Setup::
+* Usage::
+* Configuration::
+@end menu
Please add something to the right-hand side.
Node names are global, so they need to be less generic, to avoid
possible name clashes with the rest of the manual. For instance:
guix.el Setup
guix.el Usage
guix.el Configuration
The section names can remain unchanged, though.
+@item
+@uref{http://nongnu.org/geiser/, Geiser}, version 0.3 or later: it is
+used for interacting with guile process.
“with the Guile process”
+In rare occasions (for example if you compile your Emacs manually and
“On rare occasions”
+@node Usage
+@subsection Usage
+
+After successful setting up ``guix.el'', you should be able to use
“Once ``guix.el'' has been successfully configured, ...”
+@item C-c C-z
+Go to the Guix REPL.
Add: (@pxref{The REPL,,, geiser, Geiser User Manual})
+@menu
+* Commands::
+* List buffer::
+* Info buffer::
+@end menu
Same remark as the other menu and node names.
+@node Configuration
+@subsection Configuration
+
+There are many variables you can modify to change the appearance or
+behavior of Emacs UI. Some of these variables are described in this
s/UI/user interface/
+@menu
+* Guile and Build Options::
+* Keymaps::
+* Appearance::
+@end menu
RHS and node names.
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -584,6 +584,7 @@ management tools it provides.
* Invoking guix gc:: Running the garbage collector.
* Invoking guix pull:: Fetching the latest Guix and distribution.
* Invoking guix archive:: Exporting and importing store files.
+* Emacs Interface:: Package management from Emacs.
@end menu
What about moving it higher, just after “Invoking guix package”?
Thank you!
Ludo’.
