doc: extend breakpointHook documentation

This commit is contained in:
Jörg Thalheim 2018-10-26 10:53:21 +01:00
parent a8df9ff9d9
commit 7f80fb2db4
No known key found for this signature in database
GPG Key ID: CA4106B8D7CC79FA

View File

@ -2451,16 +2451,19 @@ addEnvHooks "$hostOffset" myBashFunction
</term> </term>
<listitem> <listitem>
<para> <para>
This hook will make a build pause instead of stopping This hook will make a build pause instead of stopping when a failure
when a failure happen. It prevents nix to cleanup the build happen. It prevents nix to cleanup the build environment immediatly and
environment immediatly and allows the user to attach allows the user to attach to a build environment using the
to a build environemnt using the <varname>cntr</varname> command. <command>cntr</command> command. On build error it will print the
On build error it will print the instruction that are neccessary for cntr. instruction that are neccessary for <command>cntr</command>. Installing
Note that <varname>cntr</varname> is not installed by default and cntr and running the command will provide shell access to the build
needs to be installed seperatly. <varname>cntr</varname> also needs to be executed sandbox of failed build. At <filename>/var/lib/cntr</filename> the
on the machine that is doing the build, which might be not the case sandbox filesystem is mounted. All commands and files of the system are
when remote builders are enabled. <varname>cntr</varname> is only supported still accessible within the shell. To execute commands from the sandbox
on linux based platforms. 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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>