guix-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Merging guix.el


From: Ludovic Courtès
Subject: Re: Merging guix.el
Date: Tue, 02 Sep 2014 00:28:40 +0200
User-agent: Gnus/5.130011 (Ma Gnus v0.11) Emacs/24.3 (gnu/linux)

Alex Kost <address@hidden> 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 address@hidden, 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.

address@hidden
+* Initial Setup::
+* Usage::
+* Configuration::
address@hidden 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.

address@hidden
address@hidden://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”

address@hidden Usage
address@hidden Usage
+
+After successful setting up ``guix.el'', you should be able to use

“Once ``guix.el'' has been successfully configured, ...”

address@hidden C-c C-z
+Go to the Guix REPL.

Add: (@pxref{The REPL,,, geiser, Geiser User Manual})

address@hidden
+* Commands::
+* List buffer::
+* Info buffer::
address@hidden menu

Same remark as the other menu and node names.

address@hidden Configuration
address@hidden 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/

address@hidden
+* Guile and Build Options::
+* Keymaps::
+* Appearance::
address@hidden 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’.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]