diff options
Diffstat (limited to 'doc/contributing/submitting-changes.xml')
-rw-r--r-- | doc/contributing/submitting-changes.xml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/contributing/submitting-changes.xml b/doc/contributing/submitting-changes.xml index 950e1ea974a..f283ae1e685 100644 --- a/doc/contributing/submitting-changes.xml +++ b/doc/contributing/submitting-changes.xml @@ -317,25 +317,25 @@ Additional information. </section> <section xml:id="submitting-changes-tested-compilation"> - <title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title> + <title>Tested compilation of all pkgs that depend on this change using <command>nixpkgs-review</command></title> <para> - 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. + If you are updating a package's version, you can use nixpkgs-review to make sure all packages that depend on the updated package still compile correctly. The <command>nixpkgs-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 changes from pull request number 12345: - <screen>nix run nixpkgs.nix-review -c nix-review pr 12345</screen> + <screen>nix run nixpkgs.nixpkgs-review -c nixpkgs-review pr 12345</screen> </para> <para> review uncommitted changes: - <screen>nix run nixpkgs.nix-review -c nix-review wip</screen> + <screen>nix run nixpkgs.nixpkgs-review -c nixpkgs-review wip</screen> </para> <para> review changes from last commit: - <screen>nix run nixpkgs.nix-review -c nix-review rev HEAD</screen> + <screen>nix run nixpkgs.nixpkgs-review -c nixpkgs-review rev HEAD</screen> </para> </section> @@ -408,7 +408,7 @@ Additional information. <section xml:id="submitting-changes-master-branch"> <title>Master branch</title> <para> - The <literal>master</literal> branch is the main development branch. + The <literal>master</literal> branch is the main development branch. It should only see non-breaking commits that do not cause mass rebuilds. </para> </section> @@ -416,8 +416,8 @@ Additional information. <section xml:id="submitting-changes-staging-branch"> <title>Staging branch</title> <para> - The <literal>staging</literal> branch is a development branch where mass-rebuilds go. - It should only see non-breaking mass-rebuild commits. + The <literal>staging</literal> branch is a development branch where mass-rebuilds go. + It should only see non-breaking mass-rebuild commits. That means it is not to be used for testing, and changes must have been well tested already. If the branch is already in a broken state, please refrain from adding extra new breakages. </para> @@ -426,10 +426,10 @@ Additional information. <section xml:id="submitting-changes-staging-next-branch"> <title>Staging-next branch</title> <para> - The <literal>staging-next</literal> branch is for stabilizing mass-rebuilds submitted to the <literal>staging</literal> branch prior to merging them into <literal>master</literal>. - Mass-rebuilds should go via the <literal>staging</literal> branch. + The <literal>staging-next</literal> branch is for stabilizing mass-rebuilds submitted to the <literal>staging</literal> branch prior to merging them into <literal>master</literal>. + Mass-rebuilds should go via the <literal>staging</literal> branch. It should only see non-breaking commits that are fixing issues blocking it from being merged into the <literal>master </literal> branch. - </para> + </para> <para> If the branch is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days and then merge into master. </para> |