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'.
This commit is contained in:
Ludovic Courtès 2022-01-03 17:44:31 +01:00
parent a41ad2c1f1
commit 4362125033
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5

View file

@ -7625,8 +7625,22 @@ or replace package inputs.
@deffn {Scheme Syntax} modify-inputs @var{inputs} @var{clauses} @deffn {Scheme Syntax} modify-inputs @var{inputs} @var{clauses}
Modify the given package inputs, as returned by @code{package-inputs} & co., 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 according to the given clauses. Each clause must have one of the
inputs of Coreutils and adds libcap to the back of the input list: 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 @lisp
(modify-inputs (package-inputs coreutils) (modify-inputs (package-inputs coreutils)