From mboxrd@z Thu Jan 1 00:00:00 1970 From: myglc2 Subject: [PATCH] doc: Explain when guix edit is read-only. Date: Thu, 21 Jul 2016 18:35:34 -0400 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:47633) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bQMb8-0007XP-GD for guix-devel@gnu.org; Thu, 21 Jul 2016 18:37:43 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bQMb2-0006nQ-Fj for guix-devel@gnu.org; Thu, 21 Jul 2016 18:37:41 -0400 Received: from plane.gmane.org ([80.91.229.3]:33251) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bQMb2-0006nH-8t for guix-devel@gnu.org; Thu, 21 Jul 2016 18:37:36 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1bQMb0-0002Ak-3r for guix-devel@gnu.org; Fri, 22 Jul 2016 00:37:34 +0200 Received: from c-73-167-118-254.hsd1.ma.comcast.net ([73.167.118.254]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 22 Jul 2016 00:37:34 +0200 Received: from myglc2 by c-73-167-118-254.hsd1.ma.comcast.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 22 Jul 2016 00:37:34 +0200 List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: guix-devel@gnu.org * doc/guix.texi (Invoking guix edit): Explain when you can and can't edit the recipe --- doc/guix.texi | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index e7b233d..914d24d 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -4485,7 +4485,7 @@ You can freely access a huge library of build logs! @cindex package definition, editing So many packages, so many source files! The @command{guix edit} command -facilitates the life of packagers by pointing their editor at the source +facilitates the life of users and packagers by pointing their editor at the source file containing the definition of the specified packages. For instance: @example @@ -4494,9 +4494,15 @@ guix edit gcc@@4.9 vim @noindent launches the program specified in the @code{VISUAL} or in the -@code{EDITOR} environment variable to edit the recipe of GCC@tie{}4.9.3 +@code{EDITOR} environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim. +If you are using a Guix Git checkout (@pxref{Building from Git}), or +have created your own packages on ‘GUIX_PACKAGE_PATH’ (*note Defining +Packages::), you will be able to edit the package recipes. Otherwise, +you will be able to examine the read-only recipes for packages currently +in the store. + If you are using Emacs, note that the Emacs user interface provides the @kbd{M-x guix-edit} command and a similar functionality in the ``package info'' and ``package list'' buffers created by the @kbd{M-x -- 2.9.1