From 7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 26 Oct 2018 10:53:21 +0100 Subject: [PATCH] doc: extend breakpointHook documentation --- doc/stdenv.xml | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 4f121e328cb..7d86c0870b7 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2451,16 +2451,19 @@ addEnvHooks "$hostOffset" myBashFunction - 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. + 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 environment using the + cntr command. On build error it will print the + instruction that are neccessary for cntr. Installing + cntr and running the command will provide shell access to the build + sandbox of failed build. At /var/lib/cntr the + sandbox filesystem is mounted. All commands and files of the system are + still accessible within the shell. To execute commands from the sandbox + use the cntr exec subcommand. Note that 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.