summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorJörg Thalheim <Mic92@users.noreply.github.com>2018-10-25 10:38:29 +0100
committerGitHub <noreply@github.com>2018-10-25 10:38:29 +0100
commit926d6c0bad41a094aefe0a9d3bbd14ccec83b30e (patch)
treefdd0209198c9ac1e5da9198d38bba375e22dddcb /doc
parent26974e962ebc5c1e3dfd8f6a84402ad72dc43d24 (diff)
parent325a5699cb0002b135f778497486366c92e3f8e7 (diff)
downloadnixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar.gz
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar.bz2
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar.lz
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar.xz
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.tar.zst
nixlib-926d6c0bad41a094aefe0a9d3bbd14ccec83b30e.zip
Merge pull request #42371 from Mic92/nix-breakpoints
breakpointHook: add for debugging failing builds
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv.xml19
1 files changed, 19 insertions, 0 deletions
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>