summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorDaniƫl de Kok <me@danieldk.eu>2021-03-06 11:49:21 +0100
committerGitHub <noreply@github.com>2021-03-06 11:49:21 +0100
commit158578de40d9ca117f7e69d80eeb28e8dac583fe (patch)
tree74bfe086c83e94737d18fe58dcfad21b40b1bcb2 /nixos
parent1d0cd06d37a34ff16b72ba15a8598dddf06c9a9e (diff)
parent3faea849b9bc72da2c07be3b2d977aaa323af7a4 (diff)
downloadnixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar.gz
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar.bz2
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar.lz
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar.xz
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.tar.zst
nixpkgs-158578de40d9ca117f7e69d80eeb28e8dac583fe.zip
Merge pull request #114731 from danieldk/release-notes-cargo-hooks
nixos/rl-2105: add hookification of buildRustPackage
Diffstat (limited to 'nixos')
-rw-r--r--nixos/doc/manual/release-notes/rl-2105.xml34
1 files changed, 34 insertions, 0 deletions
diff --git a/nixos/doc/manual/release-notes/rl-2105.xml b/nixos/doc/manual/release-notes/rl-2105.xml
index 566cd5d7240..0666b4300ec 100644
--- a/nixos/doc/manual/release-notes/rl-2105.xml
+++ b/nixos/doc/manual/release-notes/rl-2105.xml
@@ -754,6 +754,40 @@ self: super:
      once during the time when the timer was inactive.
     </para>
    </listitem>
+   <listitem>
+    <para>
+     The <literal>rustPlatform.buildRustPackage</literal> function is split into several hooks:
+     <package>cargoSetupHook</package> to set up vendoring for Cargo-based projects,
+     <package>cargoBuildHook</package> to build a project using Cargo,
+     <package>cargoInstallHook</package> to install a project using Cargo, and
+     <package>cargoCheckHook</package> to run tests in Cargo-based projects. With this change,
+     mixed-language projects can use the relevant hooks within builders other than
+     <literal>buildRustPackage</literal>. However, these changes also required several API changes to
+     <literal>buildRustPackage</literal> itself:
+
+     <itemizedlist>
+      <listitem>
+       <para>
+        The <literal>target</literal> argument was removed. Instead, <literal>buildRustPackage</literal>
+        will always use the same target as the C/C++ compiler that is used.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        The <literal>cargoParallelTestThreads</literal> argument was removed. Parallel tests are
+        now disabled through <literal>dontUseCargoParallelTests</literal>.
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     The <literal>rustPlatform.maturinBuildHook</literal> hook was added. This hook can be used
+     with <literal>buildPythonPackage</literal> to build Python packages that are written in Rust
+     and use Maturin as their build tool.
+    </para>
+   </listitem>
   </itemizedlist>
  </section>
 </section>