diff --git a/doc/stdenv.xml b/doc/stdenv.xml index cc0c13c5447..c3b155ab0e9 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2445,6 +2445,25 @@ addEnvHooks "$hostOffset" myBashFunction + + + breakpointHook + + + + 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 cntr command. + On build error it will print the instruction that are neccessary for cntr. + Note that cntr is not installed by default and + needs to be installed seperatly. cntr also needs to be executed + on the machine that is doing the build, which might be not the case + when remote builders are enabled. cntr is only supported + on linux based platforms. + + +