From 7f80fb2db4a0a0d0fc6456fbb8c5d193e43f1348 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 26 Oct 2018 10:53:21 +0100 Subject: [PATCH 1/2] doc: extend breakpointHook documentation --- doc/stdenv.xml | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 4f121e328cb7..7d86c0870b73 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2451,16 +2451,19 @@ addEnvHooks "$hostOffset" myBashFunction - 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 cntr command. - On build error it will print the instruction that are neccessary for cntr. - Note that cntr is not installed by default and - needs to be installed seperatly. cntr also needs to be executed - on the machine that is doing the build, which might be not the case - when remote builders are enabled. cntr is only supported - on linux based platforms. + 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 environment using the + cntr command. On build error it will print the + instruction that are neccessary for cntr. Installing + cntr and running the command will provide shell access to the build + sandbox of failed build. At /var/lib/cntr the + sandbox 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 cntr also + needs to be executed on the machine that is doing the build, which might + be not the case when remote builders are enabled. + cntr is only supported on linux based platforms. From 764d165f43483b9f570a7b5bc267016120eafac8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 26 Oct 2018 11:13:54 +0100 Subject: [PATCH 2/2] doc: apply `make format` --- doc/languages-frameworks/coq.xml | 4 ++-- doc/stdenv.xml | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/languages-frameworks/coq.xml b/doc/languages-frameworks/coq.xml index 640b04c7da9d..4314df5c9df2 100644 --- a/doc/languages-frameworks/coq.xml +++ b/doc/languages-frameworks/coq.xml @@ -12,8 +12,8 @@ Some extensions (plugins) might require OCaml and sometimes other OCaml - packages. The coq.ocamlPackages attribute can be used - to depend on the same package set Coq was built against. + packages. The coq.ocamlPackages attribute can be used to + depend on the same package set Coq was built against. diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 7d86c0870b73..b2f30bf08db1 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2099,13 +2099,13 @@ someVar=$(stripHash $name) - In order to alleviate this burden, the setup - hook mechanism was written, where any package can include a - shell script that [by convention rather than enforcement by Nix], any - downstream reverse-dependency will source as part of its build process. That - allows the downstream dependency to merely specify its dependencies, and - lets those dependencies effectively initialize themselves. No boilerplate - mirroring the list of dependencies is needed. + In order to alleviate this burden, the setup hook + mechanism was written, where any package can include a shell script that [by + convention rather than enforcement by Nix], any downstream + reverse-dependency will source as part of its build process. That allows the + downstream dependency to merely specify its dependencies, and lets those + dependencies effectively initialize themselves. No boilerplate mirroring the + list of dependencies is needed.