summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-06-17 21:58:04 +0200
committerLudovic Courtès <ludo@gnu.org>2015-06-18 00:25:49 +0200
commit39bee8a2937ea28e74b5c807962fb8bc87fe6887 (patch)
treeb4141bbc425ef3d788d1cf4827ccb4dbe86f1620 /doc
parent84189ebc66266f03b9ca7e8b912d529886436851 (diff)
Add 'guix edit'.
* guix/scripts/edit.scm: New file. * Makefile.am (MODULES): Add it. * doc.am (SUBCOMMANDS): Add 'edit'. * doc/guix.texi (Defining Packages): Add xref to "Invoking guix edit". (Invoking guix edit): New node. * po/guix/POTFILES.in: Add it.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi29
1 files changed, 28 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 1c7f4e12325..a93003d625b 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -124,6 +124,7 @@ Defining Packages
124Utilities 124Utilities
125 125
126* Invoking guix build:: Building packages from the command line. 126* Invoking guix build:: Building packages from the command line.
127* Invoking guix edit::
127* Invoking guix download:: Downloading a file and printing its hash. 128* Invoking guix download:: Downloading a file and printing its hash.
128* Invoking guix hash:: Computing the cryptographic hash of a file. 129* Invoking guix hash:: Computing the cryptographic hash of a file.
129* Invoking guix import:: Importing package definitions. 130* Invoking guix import:: Importing package definitions.
@@ -1931,7 +1932,10 @@ unavailable to the build process, possibly leading to a build failure.
1931 1932
1932Once a package definition is in place, the 1933Once a package definition is in place, the
1933package may actually be built using the @code{guix build} command-line 1934package may actually be built using the @code{guix build} command-line
1934tool (@pxref{Invoking guix build}). @xref{Packaging Guidelines}, for 1935tool (@pxref{Invoking guix build}). You can easily jump back to the
1936package definition using the @command{guix edit} command
1937(@pxref{Invoking guix edit}).
1938@xref{Packaging Guidelines}, for
1935more information on how to test package definitions, and 1939more information on how to test package definitions, and
1936@ref{Invoking guix lint}, for information on how to check a definition 1940@ref{Invoking guix lint}, for information on how to check a definition
1937for style conformance. 1941for style conformance.
@@ -3261,6 +3265,7 @@ programming interface of Guix in a convenient way.
3261 3265
3262@menu 3266@menu
3263* Invoking guix build:: Building packages from the command line. 3267* Invoking guix build:: Building packages from the command line.
3268* Invoking guix edit:: Editing package definitions.
3264* Invoking guix download:: Downloading a file and printing its hash. 3269* Invoking guix download:: Downloading a file and printing its hash.
3265* Invoking guix hash:: Computing the cryptographic hash of a file. 3270* Invoking guix hash:: Computing the cryptographic hash of a file.
3266* Invoking guix import:: Importing package definitions. 3271* Invoking guix import:: Importing package definitions.
@@ -3548,6 +3553,28 @@ the parsed command-line options.
3548@end defvr 3553@end defvr
3549 3554
3550 3555
3556@node Invoking guix edit
3557@section Invoking @command{guix edit}
3558
3559@cindex package definition, editing
3560So many packages, so many source files! The @command{guix edit} command
3561facilitates the life of packagers by pointing their editor at the source
3562file containing the definition of the specified packages. For instance:
3563
3564@example
3565guix edit gcc-4.8 vim
3566@end example
3567
3568@noindent
3569launches the program specified in the @code{EDITOR} environment variable
3570to edit the recipe of GCC@tie{}4.8.4 and that of Vim.
3571
3572If you are using Emacs, note that the Emacs user interface provides
3573similar functionality in the ``package info'' buffers created by
3574@kbd{M-x guix-search-by-name} and similar commands (@pxref{Emacs
3575Commands}).
3576
3577
3551@node Invoking guix download 3578@node Invoking guix download
3552@section Invoking @command{guix download} 3579@section Invoking @command{guix download}
3553 3580