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

Merge pull request #49146 from Mic92/breakpoint2

Browse Source 
doc/breakpointHook: improve documentation
This commit is contained in:
Jörg Thalheim 2018-10-26 12:22:01 +01:00 committed by GitHub
commit 67adcd1a38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/languages-frameworks/coq.xml
View File

@ -12,8 +12,8 @@
<para> <para>
Some extensions (plugins) might require OCaml and sometimes other OCaml Some extensions (plugins) might require OCaml and sometimes other OCaml
packages. The <literal>coq.ocamlPackages</literal> attribute can be used packages. The <literal>coq.ocamlPackages</literal> attribute can be used to
to depend on the same package set Coq was built against. depend on the same package set Coq was built against.
</para> </para>
<para> <para>

37
doc/stdenv.xml
View File

@ -2099,13 +2099,13 @@ someVar=$(stripHash $name)
</para> </para>
<para> <para>
In order to alleviate this burden, the <firstterm>setup In order to alleviate this burden, the <firstterm>setup hook</firstterm>
hook</firstterm> mechanism was written, where any package can include a mechanism was written, where any package can include a shell script that [by
shell script that [by convention rather than enforcement by Nix], any convention rather than enforcement by Nix], any downstream
downstream reverse-dependency will source as part of its build process. That reverse-dependency will source as part of its build process. That allows the
allows the downstream dependency to merely specify its dependencies, and downstream dependency to merely specify its dependencies, and lets those
lets those dependencies effectively initialize themselves. No boilerplate dependencies effectively initialize themselves. No boilerplate mirroring the
mirroring the list of dependencies is needed. list of dependencies is needed.
</para> </para>
<para> <para>
@ -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>