GNU bug report logs - #22587
"guix edit" name may be confusing

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: myglc2 <myglc2 <at> gmail.com>
To: bug-guix <at> gnu.org
Subject: ‘guix edit’ & ‘M-x
 guix-edit' typo, rename, & mode change
Date: Sun, 07 Feb 2016 13:04:40 -0500

Alex Kost <alezost <at> gmail.com> writes:
[...]
> The purpose of "M-x guix-edit" Emacs command (and "guix edit" shell
> command) is just to show you the source code of the package.  This
> source is usually placed in the store, and you shouldn't edit it.  If
> you are going to contribute to guix, (info "(guix) Building from Git")
> is the right way.

From guix INFO:

6.2 Invoking ‘guix edit’
[...]
launches the program specified in the ‘VISUAL’ or in the ‘EDITOR’
environment variable to edit the recipe of GCC 4.8.4 and that of Vim."

TYPO:

"edit" (last line above) should be replaced with "view", "inspect", or
"examine".

RENAME:

Calling these functions 'guix edit' and 'M-x guix-edit' implies that the
user will be able to modify the recipe, but this is not actually the
case. The functions should be given a more informative and accurate
name, such as: 'guix view', 'guix inspect', or 'guix examine'.

MODE CHANGE:

In emacs, read-only .scm files should be opened in view-mode.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.