JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/breakpointHook: add documentation

Browse Source
This commit is contained in:
Jörg Thalheim 2018-10-25 09:52:21 +01:00
parent f10b935f84
commit 325a5699cb
No known key found for this signature in database
GPG Key ID: CA4106B8D7CC79FA
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/stdenv.xml
View File

@ -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>