diff options
author | Ludovic Courtès <ludovic.courtes@inria.fr> | 2022-06-23 18:02:11 +0200 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2022-06-23 23:20:55 +0200 |
commit | 2327bf41d97fa92c078d0eeeec4f2729ade33105 (patch) | |
tree | f2a0582a869414c3594d61b723fdb6fb3af7a3b2 /doc/guix.texi | |
parent | 054937f17d2de8c1e912113c32e4c1c071448dfc (diff) |
doc: Expound description of the <package> 'arguments' field.
* doc/guix.texi (package Reference): Augment description of the
'arguments' field.
Diffstat (limited to 'doc/guix.texi')
-rw-r--r-- | doc/guix.texi | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 9f3f1e39a4..874dab1597 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -7379,8 +7379,25 @@ The build system that should be used to build the package (@pxref{Build Systems}). @item @code{arguments} (default: @code{'()}) -The arguments that should be passed to the build system. This is a -list, typically containing sequential keyword-value pairs. +The arguments that should be passed to the build system (@pxref{Build +Systems}). This is a list, typically containing sequential +keyword-value pairs, as in this example: + +@lisp +(package + (name "example") + ;; several fields omitted + (arguments + (list #:tests? #f ;skip tests + #:make-flags #~'("VERBOSE=1") ;pass flags to 'make' + #:configure-flags #~'("--enable-frobbing")))) +@end lisp + +The exact set of supported keywords depends on the build system +(@pxref{Build Systems}), but you will find that almost all of them honor +@code{#:configure-flags}, @code{#:make-flags}, @code{#:tests?}, and +@code{#:phases}. The @code{#:phases} keyword in particular lets you +modify the set of build phases for your package (@pxref{Build Phases}). @item @code{inputs} (default: @code{'()}) @itemx @code{native-inputs} (default: @code{'()}) |