From 22d083e6598293c7c23a062689bb84e751e35ee7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 8 Mar 2019 14:17:28 +0000 Subject: [PATCH] doc/reviewing-contributions: nix-review instead of nox-review It is faster, handles more edge cases and allows to test/review the built packages interactively. --- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- doc/reviewing-contributions.xml | 10 +++++----- doc/submitting-changes.xml | 22 +++++++++++----------- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 22940f5ea989..7b4ec78e4090 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,11 +11,10 @@ - [ ] macOS - [ ] other Linux distributions - [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) -- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nox --run "nox-review wip"` +- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nix-review --run "nix-review wip"` - [ ] Tested execution of all binary files (usually in `./result/bin/`) - [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after) - [ ] Assured whether relevant documentation is up to date - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). --- - diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml index f541b7f22daa..f3448475192d 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -187,14 +187,14 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD - The nox tool can - be used to review a pull request content in a single command. It doesn't - rebase on a channel branch so it might trigger multiple source builds. + 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. + of the pull request title. You can also provide the full github pull + request url. -$ nix-shell -p nox --run "nox-review -k pr PRNUMBER" +$ nix-shell -p nix-review --run "nix-review pr PRNUMBER" diff --git a/doc/submitting-changes.xml b/doc/submitting-changes.xml index 4a6a2c634a58..33abfb634ea2 100644 --- a/doc/submitting-changes.xml +++ b/doc/submitting-changes.xml @@ -351,26 +351,26 @@ Additional information.
- Tested compilation of all pkgs that depend on this change using <command>nox-review</command> + 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 nox to make sure all - packages that depend on the updated package still compile correctly. This - can be done using the nox utility. The nox-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 uncommitted changes: -nix-shell -p nox --run "nox-review wip" + 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 nox --run "nox-review pr 12345" + review uncommitted changes: + nix-shell -p nix-review --run "nix-review wip" +