diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml index 029299a50b1..6e3b6face3a 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -189,7 +189,8 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD - The nix-review + The + nix-review tool can be used to review a pull request content in a single command. PRNUMBER should be replaced by the number at the end of the pull request title. You can also provide the full github pull diff --git a/doc/stdenv.xml b/doc/stdenv.xml index a3990dec052..7e6c589d9fe 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 cntr command. Upon build error it will print - instructions on how to use cntr, 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 /var/lib/cntr 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 cntr also needs - to be executed on the machine that is doing the build, which might not - be the case when remote builders are enabled. cntr is - only supported on Linux-based platforms. To use it first add - cntr to your - environment.systemPackages on NixOS or alternatively - to the root user on non-NixOS systems. Then in the package that is - supposed to be inspected, add breakpointHook to - nativeBuildInputs. + instructions on how to use cntr, 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 /var/lib/cntr 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 cntr also needs to be executed + on the machine that is doing the build, which might not be the case when + remote builders are enabled. cntr is only supported + on Linux-based platforms. To use it first add cntr to + your environment.systemPackages on NixOS or + alternatively to the root user on non-NixOS systems. Then in the package + that is supposed to be inspected, add breakpointHook + to nativeBuildInputs. nativeBuildInputs = [ breakpointHook ]; diff --git a/doc/submitting-changes.xml b/doc/submitting-changes.xml index 33abfb634ea..bc090fd757c 100644 --- a/doc/submitting-changes.xml +++ b/doc/submitting-changes.xml @@ -354,23 +354,22 @@ Additional information. Tested compilation of all pkgs that depend on this change using <command>nix-review</command> - If you are updating a package's version, you can use nix-review to make sure all - packages that depend on the updated package still compile correctly. - The nix-review utility can look for and build all dependencies - either based on uncommited changes with the wip option or - specifying a github pull request number. + If you are updating a package's version, you can use nix-review to make + sure all packages that depend on the updated package still compile + correctly. The nix-review utility can look for and build + all dependencies either based on uncommited changes with the + wip option or specifying a github pull request number. - review changes from pull request number 12345: - nix-shell -p nix-review --run "nix-review pr 12345" + review changes from pull request number 12345: +nix-shell -p nix-review --run "nix-review pr 12345" - review uncommitted changes: - nix-shell -p nix-review --run "nix-review wip" + review uncommitted changes: +nix-shell -p nix-review --run "nix-review wip" -