diff options
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r-- | doc/stdenv.xml | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index a3990dec052f..7e6c589d9fe9 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2633,21 +2633,20 @@ addEnvHooks "$hostOffset" myBashFunction happens. It prevents nix from cleaning up the build environment immediately and allows the user to attach to a build environment using the <command>cntr</command> command. Upon build error it will print - instructions on how to use <command>cntr</command>, which can be used - to enter the environment for debugging. Installing cntr and - running the command will provide shell access to the build sandbox of - failed build. At <filename>/var/lib/cntr</filename> the sandboxed - 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 not - be the case when remote builders are enabled. <command>cntr</command> is - only supported on Linux-based platforms. To use it first add - <literal>cntr</literal> to your - <literal>environment.systemPackages</literal> on NixOS or alternatively - to the root user on non-NixOS systems. Then in the package that is - supposed to be inspected, add <literal>breakpointHook</literal> to - <literal>nativeBuildInputs</literal>. + instructions on how to use <command>cntr</command>, which can be used to + enter the environment for debugging. Installing cntr and running the + command will provide shell access to the build sandbox of failed build. + At <filename>/var/lib/cntr</filename> the sandboxed 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 not be the case when + remote builders are enabled. <command>cntr</command> is only supported + on Linux-based platforms. To use it first add <literal>cntr</literal> to + your <literal>environment.systemPackages</literal> on NixOS or + alternatively to the root user on non-NixOS systems. Then in the package + that is supposed to be inspected, add <literal>breakpointHook</literal> + to <literal>nativeBuildInputs</literal>. <programlisting> nativeBuildInputs = [ breakpointHook ]; </programlisting> |