From 325a5699cb0002b135f778497486366c92e3f8e7 Mon Sep 17 00:00:00 2001
From: Jörg Thalheim <joerg@thalheim.io>
Date: Thu, 25 Oct 2018 09:52:21 +0100
Subject: doc/breakpointHook: add documentation

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

(limited to 'doc')

diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index cc0c13c54471..c3b155ab0e9f 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -2445,6 +2445,25 @@ addEnvHooks "$hostOffset" myBashFunction
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term>
+      breakpointHook
+     </term>
+     <listitem>
+      <para>
+       This hook will make a build pause instead of stopping
+       when a failure happen. It prevents nix to cleanup the build
+       environment immediatly and allows the user to attach
+       to a build environemnt using the <varname>cntr</varname> command.
+       On build error it will print the instruction that are neccessary for cntr.
+       Note that <varname>cntr</varname> is not installed by default and
+       needs to be installed seperatly. <varname>cntr</varname> also needs to be executed
+       on the machine that is doing the build, which might be not the case
+       when remote builders are enabled. <varname>cntr</varname> is only supported
+       on linux based platforms.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </section>
-- 
cgit 1.4.1