summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorVladimír Čunát <vcunat@gmail.com>2016-09-28 17:13:59 +0200
committerVladimír Čunát <vcunat@gmail.com>2016-09-28 17:13:59 +0200
commit77604964b695c3fba644684198a4c1f3bf8f607d (patch)
tree126e7d89165d72b75ab78b0b057ec5588e2a3e0c /doc
parent3e1afeaa5b83559698fb6fa3a45947f3e14da534 (diff)
parentbc2a06aa3d88b7d093d84663b210a75c66c93ef0 (diff)
downloadnixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar.gz
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar.bz2
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar.lz
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar.xz
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.tar.zst
nixlib-77604964b695c3fba644684198a4c1f3bf8f607d.zip
Merge branch 'master' into staging
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv.xml35
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>