diff options
| author | Eric Sagnes <eric.sagnes@gmail.com> | 2016-09-28 13:15:20 +0900 |
|---|---|---|
| committer | Eric Sagnes <eric.sagnes@gmail.com> | 2016-09-28 16:31:46 +0900 |
| commit | 41d62fdea86339fb25e1f9a2414fe1e04fd704e1 (patch) | |
| tree | 49463819b0f76508ecaff5a8fe444d690796bbed /doc | |
| parent | cdec20ac58325af1f606a59413d5a31fc839c8d4 (diff) | |
| download | nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar.gz nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar.bz2 nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar.lz nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar.xz nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.tar.zst nixlib-41d62fdea86339fb25e1f9a2414fe1e04fd704e1.zip | |
nixpkgs doc: add installCheck phase
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/stdenv.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index c17d7c51ae21..3da3dd8df96e 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -988,6 +988,41 @@ set debug-file-directory ~/.nix-profile/lib/debug </section> +<section xml:id="ssec-installCheck-phase"><title>The installCheck phase</title> + +<para>The installCheck phase checks whether the package was installed +correctly by running its test suite against the installed directories. +The default <function>installCheck</function> calls <command>make +installcheck</command>.</para> + +<variablelist> + <title>Variables controlling the installCheck phase</title> + + <varlistentry> + <term><varname>doInstallCheck</varname></term> + <listitem><para>If set to a non-empty string, the installCheck phase is + executed, otherwise it is skipped (default). Thus you should set + + <programlisting>doInstallCheck = true;</programlisting> + + in the derivation to enable install checks.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>preInstallCheck</varname></term> + <listitem><para>Hook executed at the start of the installCheck + phase.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>postInstallCheck</varname></term> + <listitem><para>Hook executed at the end of the installCheck + phase.</para></listitem> + </varlistentry> + +</variablelist> + +</section> <section xml:id="ssec-distribution-phase"><title>The distribution phase</title> |