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

doc/stdenv: put note about remote builds with breakpointHook into a <note>

Browse Source 
With remote builds, the sandbox can't be accessed by `cntr` as it is on
a different machine. I decided to put this into an extra `note` block as it took
me admittedly too much time to figure this out.
This commit is contained in:
Maximilian Bosch 2019-05-06 16:42:34 +02:00
parent 0d00b0b646
commit 0f9653f7ed
No known key found for this signature in database
GPG Key ID: 091DBF4D1FC46B8E
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/stdenv.xml
View File

@ -2643,9 +2643,7 @@ addEnvHooks "$hostOffset" myBashFunction
At <filename>/var/lib/cntr</filename> the sandboxed filesystem is At <filename>/var/lib/cntr</filename> the sandboxed filesystem is
mounted. All commands and files of the system are still accessible mounted. All commands and files of the system are still accessible
within the shell. To execute commands from the sandbox use the cntr exec within the shell. To execute commands from the sandbox use the cntr exec
subcommand. Note that <command>cntr</command> also needs to be executed subcommand. <command>cntr</command> is only supported
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 on Linux-based platforms. To use it first add <literal>cntr</literal> to
your <literal>environment.systemPackages</literal> on NixOS or your <literal>environment.systemPackages</literal> on NixOS or
alternatively to the root user on non-NixOS systems. Then in the package alternatively to the root user on non-NixOS systems. Then in the package
@ -2657,6 +2655,16 @@ addEnvHooks "$hostOffset" myBashFunction
When a build failure happens there will be an instruction printed that When a build failure happens there will be an instruction printed that
shows how to attach with <literal>cntr</literal> to the build sandbox. shows how to attach with <literal>cntr</literal> to the build sandbox.
</para> </para>
<note>
<title>Caution with remote builds</title>
<para>
This won't work with remote builds as the build environment is on
a different machine and can't be accessed by <command>cntr</command>.
Remote builds can be turned off by setting <literal>--option builders ''</literal>
for <command>nix-build</command> or <literal>--builders ''</literal> for
<command>nix build</command>.
</para>
</note>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>