03/05: doc: Document clauses of 'modify-inputs'.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit 4362125033e8c38d1693450d916facf3940af621
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Mon Jan 3 17:44:31 2022 +0100

    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'.
---
 doc/guix.texi | 18 ++++++++++++++++--
 1 file 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)