summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2022-01-03 17:44:31 +0100
committerLudovic Courtès <ludo@gnu.org>2022-01-03 19:32:08 +0100
commit4362125033e8c38d1693450d916facf3940af621 (patch)
tree27199735954d2387e6077d7f4e0c2d309824322d
parenta41ad2c1f19edc069cd68c4819adc72198476a92 (diff)
doc: Document clauses of 'modify-inputs'.
Suggested by Alexander Asteroth <alexander.asteroth@h-brs.de>. * doc/guix.texi (Defining Package Variants): Document all the supported clauses of 'modify-inputs'.
-rw-r--r--doc/guix.texi18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index e7310de3a0..43549da388 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7625,8 +7625,22 @@ or replace package inputs.
@deffn {Scheme Syntax} modify-inputs @var{inputs} @var{clauses}
Modify the given package inputs, as returned by @code{package-inputs} & co.,
-according to the given clauses. The example below removes the GMP and ACL
-inputs of Coreutils and adds libcap to the back of the input list:
+according to the given clauses. Each clause must have one of the
+following forms:
+
+@table @code
+@item (delete @var{name}@dots{})
+Delete from the inputs packages with the given @var{name}s (strings).
+
+@item (append @var{package}@dots{})
+Add @var{package}s to the end of the input list.
+
+@item (prepend @var{package}@dots{})
+Add @var{package}s to the front of the input list.
+@end table
+
+The example below removes the GMP and ACL inputs of Coreutils and adds
+libcap to the back of the input list:
@lisp
(modify-inputs (package-inputs coreutils)