From e3d7e7f2a7e54978dfeccb95bb0fb9b6761fc0f7 Mon Sep 17 00:00:00 2001 From: nicoo Date: Thu, 8 Aug 2024 16:48:57 +0000 Subject: [PATCH] doc/build-helpers: add note relating `runCommand` and `runCommandWith` --- .../trivial-build-helpers.chapter.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/build-helpers/trivial-build-helpers.chapter.md b/doc/build-helpers/trivial-build-helpers.chapter.md index 3d2c7f166710..42e36821d9ec 100644 --- a/doc/build-helpers/trivial-build-helpers.chapter.md +++ b/doc/build-helpers/trivial-build-helpers.chapter.md @@ -126,6 +126,24 @@ runCommand "my-example" {} '' ``` ::: +::: {.note} +`runCommand name derivationArgs buildCommand` is equivalent to +```nix +runCommandWith { + inherit name derivationArgs; + stdenv = stdenvNoCC; +} buildCommand +``` + +Likewise, `runCommandCC name derivationArgs buildCommand` is equivalent to +```nix +runCommandWith { + inherit name derivationArgs; +} buildCommand +``` +::: + + ## `runCommandLocal` {#trivial-builder-runCommandLocal} Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network round-trip and can speed up a build.