Browse Source

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.
nim-0.20.0
Jörg Thalheim 2 years ago
parent
commit
22d083e659
No account linked to committer's email address
3 changed files with 17 additions and 18 deletions
  1. 1
    2
      .github/PULL_REQUEST_TEMPLATE.md
  2. 5
    5
      doc/reviewing-contributions.xml
  3. 11
    11
      doc/submitting-changes.xml

+ 1
- 2
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -11,11 +11,10 @@
11 11
    - [ ] macOS
12 12
    - [ ] other Linux distributions
13 13
 - [ ] 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))
14
-- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nox --run "nox-review wip"`
14
+- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nix-review --run "nix-review wip"`
15 15
 - [ ] Tested execution of all binary files (usually in `./result/bin/`)
16 16
 - [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
17 17
 - [ ] Assured whether relevant documentation is up to date
18 18
 - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
19 19
 
20 20
 ---
21
-

+ 5
- 5
doc/reviewing-contributions.xml View File

@@ -187,14 +187,14 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co
187 187
      </listitem>
188 188
      <listitem>
189 189
       <para>
190
-       The <link xlink:href="https://github.com/madjar/nox">nox</link> tool can
191
-       be used to review a pull request content in a single command. It doesn't
192
-       rebase on a channel branch so it might trigger multiple source builds.
190
+       The <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link>
191
+       tool can be used to review a pull request content in a single command.
193 192
        <varname>PRNUMBER</varname> should be replaced by the number at the end
194
-       of the pull request title.
193
+       of the pull request title. You can also provide the full github pull
194
+       request url.
195 195
       </para>
196 196
 <screen>
197
-$ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
197
+$ nix-shell -p nix-review --run "nix-review pr PRNUMBER"
198 198
 </screen>
199 199
      </listitem>
200 200
     </itemizedlist>

+ 11
- 11
doc/submitting-changes.xml View File

@@ -351,26 +351,26 @@ Additional information.
351 351
   </section>
352 352
 
353 353
   <section xml:id="submitting-changes-tested-compilation">
354
-   <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>
354
+   <title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title>
355 355
 
356 356
    <para>
357
-    If you are updating a package's version, you can use nox to make sure all
358
-    packages that depend on the updated package still compile correctly. This
359
-    can be done using the nox utility. The <command>nox-review</command>
360
-    utility can look for and build all dependencies either based on uncommited
361
-    changes with the <literal>wip</literal> option or specifying a github pull
362
-    request number.
357
+    If you are updating a package's version, you can use nix-review to make sure all
358
+    packages that depend on the updated package still compile correctly.
359
+    The <command>nix-review</command> utility can look for and build all dependencies
360
+    either based on uncommited changes with the <literal>wip</literal> option or
361
+    specifying a github pull request number.
363 362
    </para>
364 363
 
365 364
    <para>
366
-    review uncommitted changes:
367
-<screen>nix-shell -p nox --run "nox-review wip"</screen>
365
+     review changes from pull request number 12345:
366
+     <screen>nix-shell -p nix-review --run "nix-review pr 12345"</screen>
368 367
    </para>
369 368
 
370 369
    <para>
371
-    review changes from pull request number 12345:
372
-<screen>nix-shell -p nox --run "nox-review pr 12345"</screen>
370
+     review uncommitted changes:
371
+     <screen>nix-shell -p nix-review --run "nix-review wip"</screen>
373 372
    </para>
373
+
374 374
   </section>
375 375
 
376 376
   <section xml:id="submitting-changes-tested-execution">

Loading…
Cancel
Save