diff options
| author | Jörg Thalheim <joerg@thalheim.io> | 2018-10-25 09:52:21 +0100 |
|---|---|---|
| committer | Jörg Thalheim <joerg@thalheim.io> | 2018-10-25 10:19:42 +0100 |
| commit | 325a5699cb0002b135f778497486366c92e3f8e7 (patch) | |
| tree | 97e3729da8d37f5647bc1b0a9774eabed56340d0 /doc | |
| parent | f10b935f84d068f616f335ad75a99f13af35337a (diff) | |
| download | nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar.gz nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar.bz2 nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar.lz nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar.xz nixlib-325a5699cb0002b135f778497486366c92e3f8e7.tar.zst nixlib-325a5699cb0002b135f778497486366c92e3f8e7.zip | |
doc/breakpointHook: add documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/stdenv.xml | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index cc0c13c54471..c3b155ab0e9f 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -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> |