From 41d62fdea86339fb25e1f9a2414fe1e04fd704e1 Mon Sep 17 00:00:00 2001
From: Eric Sagnes <eric.sagnes@gmail.com>
Date: Wed, 28 Sep 2016 13:15:20 +0900
Subject: [PATCH] nixpkgs doc: add installCheck phase

---
 doc/stdenv.xml | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

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>