diff options
author | Ludovic Courtès <ludo@gnu.org> | 2013-01-16 23:09:06 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2013-01-16 23:09:53 +0100 |
commit | 874e6874284126c8836894b0f46dce8f6e803641 (patch) | |
tree | eaa555c2b20a6ed82954f095545b70c4c7b3766f /guix/derivations.scm | |
parent | 1da983b9f083c643831db2a0381db9110e830d47 (diff) |
doc: Start documenting derivations.
* doc/guix.texi (Defining Packages): Add cross-reference to
"Derivations".
(The Store): Add `build-derivations'.
(Derivations): Populate.
Diffstat (limited to 'guix/derivations.scm')
-rw-r--r-- | guix/derivations.scm | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/guix/derivations.scm b/guix/derivations.scm index ce8858a2fa..a36a6559b4 100644 --- a/guix/derivations.scm +++ b/guix/derivations.scm @@ -610,16 +610,20 @@ they can refer to each other." (env-vars '()) (modules '()) guile-for-build) - "Return a derivation that executes Scheme expression EXP as a builder for -derivation NAME. INPUTS must be a list of (NAME DRV-PATH SUB-DRV) tuples; -when SUB-DRV is omitted, \"out\" is assumed. EXP is evaluated in an -environment where %OUTPUT is bound to the main output path, %OUTPUTS is bound -to a list of output/path pairs, and where %BUILD-INPUTS is bound to an alist -of string/output-path pairs made from INPUTS. Optionally, ENV-VARS is a list -of string pairs specifying the name and value of environment variables -visible to the builder. The builder terminates by passing the result of EXP -to `exit'; thus, when EXP returns #f, the build is considered to have -failed. + "Return a derivation that executes Scheme expression EXP as a builder +for derivation NAME. INPUTS must be a list of (NAME DRV-PATH SUB-DRV) +tuples; when SUB-DRV is omitted, \"out\" is assumed. MODULES is a list +of names of Guile modules from the current search path to be copied in +the store, compiled, and made available in the load path during the +execution of EXP. + +EXP is evaluated in an environment where %OUTPUT is bound to the main +output path, %OUTPUTS is bound to a list of output/path pairs, and where +%BUILD-INPUTS is bound to an alist of string/output-path pairs made from +INPUTS. Optionally, ENV-VARS is a list of string pairs specifying the +name and value of environment variables visible to the builder. The +builder terminates by passing the result of EXP to `exit'; thus, when +EXP returns #f, the build is considered to have failed. EXP is built using GUILE-FOR-BUILD (a derivation). When GUILE-FOR-BUILD is omitted or is #f, the value of the `%guile-for-build' fluid is used instead." |