diff options
author | Jörg Thalheim <joerg@thalheim.io> | 2019-03-08 14:17:28 +0000 |
---|---|---|
committer | Jörg Thalheim <joerg@thalheim.io> | 2019-03-20 11:28:00 +0000 |
commit | 22d083e6598293c7c23a062689bb84e751e35ee7 (patch) | |
tree | 7b45f6a3000205fdcf17be22bc1f6d217c739191 | |
parent | eb5afaf06b092469cc3875f48aa20879573f404f (diff) |
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.
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 3 | ||||
-rw-r--r-- | doc/reviewing-contributions.xml | 10 | ||||
-rw-r--r-- | 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 22940f5ea9895..7b4ec78e4090d 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 f541b7f22daa6..f3448475192d8 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -187,14 +187,14 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co </listitem> <listitem> <para> - The <link xlink:href="https://github.com/madjar/nox">nox</link> 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 <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link> + tool can be used to review a pull request content in a single command. <varname>PRNUMBER</varname> 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. </para> <screen> -$ nix-shell -p nox --run "nox-review -k pr PRNUMBER" +$ nix-shell -p nix-review --run "nix-review pr PRNUMBER" </screen> </listitem> </itemizedlist> diff --git a/doc/submitting-changes.xml b/doc/submitting-changes.xml index 4a6a2c634a582..33abfb634ea2c 100644 --- a/doc/submitting-changes.xml +++ b/doc/submitting-changes.xml @@ -351,26 +351,26 @@ Additional information. </section> <section xml:id="submitting-changes-tested-compilation"> - <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title> + <title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title> <para> - 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 <command>nox-review</command> - utility can look for and build all dependencies either based on uncommited - changes with the <literal>wip</literal> 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 <command>nix-review</command> utility can look for and build all dependencies + either based on uncommited changes with the <literal>wip</literal> option or + specifying a github pull request number. </para> <para> - review uncommitted changes: -<screen>nix-shell -p nox --run "nox-review wip"</screen> + review changes from pull request number 12345: + <screen>nix-shell -p nix-review --run "nix-review pr 12345"</screen> </para> <para> - review changes from pull request number 12345: -<screen>nix-shell -p nox --run "nox-review pr 12345"</screen> + review uncommitted changes: + <screen>nix-shell -p nix-review --run "nix-review wip"</screen> </para> + </section> <section xml:id="submitting-changes-tested-execution"> |