diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index fdd8fdf9aee..284d667f34e 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -2582,7 +2582,8 @@ a derivation is the @code{derivation} procedure: | |||
| 2582 | @var{args} [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | 2582 | @var{args} [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ |
| 2583 | [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ | 2583 | [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ |
| 2584 | [#:system (%current-system)] [#:references-graphs #f] @ | 2584 | [#:system (%current-system)] [#:references-graphs #f] @ |
| 2585 | [#:allowed-references #f] [#:leaked-env-vars #f] [#:local-build? #f] | 2585 | [#:allowed-references #f] [#:leaked-env-vars #f] [#:local-build? #f] @ |
| 2586 | [#:substitutable? #t] | ||
| 2586 | Build a derivation with the given arguments, and return the resulting | 2587 | Build a derivation with the given arguments, and return the resulting |
| 2587 | @code{<derivation>} object. | 2588 | @code{<derivation>} object. |
| 2588 | 2589 | ||
| @@ -2612,6 +2613,11 @@ When @var{local-build?} is true, declare that the derivation is not a | |||
| 2612 | good candidate for offloading and should rather be built locally | 2613 | good candidate for offloading and should rather be built locally |
| 2613 | (@pxref{Daemon Offload Setup}). This is the case for small derivations | 2614 | (@pxref{Daemon Offload Setup}). This is the case for small derivations |
| 2614 | where the costs of data transfers would outweigh the benefits. | 2615 | where the costs of data transfers would outweigh the benefits. |
| 2616 | |||
| 2617 | When @var{substitutable?} is false, declare that substitutes of the | ||
| 2618 | derivation's output should not be used (@pxref{Substitutes}). This is | ||
| 2619 | useful, for instance, when building packages that capture details of the | ||
| 2620 | host CPU instruction set. | ||
| 2615 | @end deffn | 2621 | @end deffn |
| 2616 | 2622 | ||
| 2617 | @noindent | 2623 | @noindent |
| @@ -2651,7 +2657,7 @@ is now deprecated in favor of the much nicer @code{gexp->derivation}. | |||
| 2651 | [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | 2657 | [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ |
| 2652 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ | 2658 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ |
| 2653 | [#:references-graphs #f] [#:allowed-references #f] @ | 2659 | [#:references-graphs #f] [#:allowed-references #f] @ |
| 2654 | [#:local-build? #f] [#:guile-for-build #f] | 2660 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] |
| 2655 | Return a derivation that executes Scheme expression @var{exp} as a | 2661 | Return a derivation that executes Scheme expression @var{exp} as a |
| 2656 | builder for derivation @var{name}. @var{inputs} must be a list of | 2662 | builder for derivation @var{name}. @var{inputs} must be a list of |
| 2657 | @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, | 2663 | @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, |
| @@ -2674,7 +2680,8 @@ terminates by passing the result of @var{exp} to @code{exit}; thus, when | |||
| 2674 | @code{%guile-for-build} fluid is used instead. | 2680 | @code{%guile-for-build} fluid is used instead. |
| 2675 | 2681 | ||
| 2676 | See the @code{derivation} procedure for the meaning of | 2682 | See the @code{derivation} procedure for the meaning of |
| 2677 | @var{references-graphs}, @var{allowed-references}, and @var{local-build?}. | 2683 | @var{references-graphs}, @var{allowed-references}, @var{local-build?}, |
| 2684 | and @var{substitutable?}. | ||
| 2678 | @end deffn | 2685 | @end deffn |
| 2679 | 2686 | ||
| 2680 | @noindent | 2687 | @noindent |
| @@ -3163,7 +3170,7 @@ information about monads.) | |||
| 3163 | [#:module-path @var{%load-path}] @ | 3170 | [#:module-path @var{%load-path}] @ |
| 3164 | [#:references-graphs #f] [#:allowed-references #f] @ | 3171 | [#:references-graphs #f] [#:allowed-references #f] @ |
| 3165 | [#:leaked-env-vars #f] @ | 3172 | [#:leaked-env-vars #f] @ |
| 3166 | [#:local-build? #f] [#:guile-for-build #f] | 3173 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] |
| 3167 | Return a derivation @var{name} that runs @var{exp} (a gexp) with | 3174 | Return a derivation @var{name} that runs @var{exp} (a gexp) with |
| 3168 | @var{guile-for-build} (a derivation) on @var{system}. When @var{target} | 3175 | @var{guile-for-build} (a derivation) on @var{system}. When @var{target} |
| 3169 | is true, it is used as the cross-compilation target triplet for packages | 3176 | is true, it is used as the cross-compilation target triplet for packages |
