diff options
author | Jörg Thalheim <joerg@thalheim.io> | 2018-10-26 10:53:21 +0100 |
---|---|---|
committer | Jörg Thalheim <joerg@thalheim.io> | 2018-10-26 11:13:24 +0100 |
commit | 7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348 (patch) | |
tree | ca3db5fcb696fa79e59fbbffef43389ee20d2b2e /doc | |
parent | a8df9ff9d9a7bea21f9a2bcef245ae1e2e0d0d0f (diff) | |
download | nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar.gz nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar.bz2 nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar.lz nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar.xz nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.tar.zst nixlib-7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348.zip |
doc: extend breakpointHook documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/stdenv.xml | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 4f121e328cb7..7d86c0870b73 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2451,16 +2451,19 @@ addEnvHooks "$hostOffset" myBashFunction </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. + 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 + <command>cntr</command> command. On build error it will print the + instruction that are neccessary for <command>cntr</command>. Installing + cntr and running the command will provide shell access to the build + sandbox of failed build. At <filename>/var/lib/cntr</filename> 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 <command>cntr</command> also + needs to be executed on the machine that is doing the build, which might + be not the case when remote builders are enabled. + <command>cntr</command> is only supported on linux based platforms. </para> </listitem> </varlistentry> |