diff options
Diffstat (limited to 'doc/stdenv.xml')
| -rw-r--r-- | doc/stdenv.xml | 19 |
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> |