Commit e3d7e7f2 authored by nicoo's avatar nicoo
Browse files

doc/build-helpers: add note relating `runCommand` and `runCommandWith`

parent 482d6eaa

doc/build-helpers/trivial-build-helpers.chapter.md

+18 −0
Original line number Diff line number Diff line
@@ -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.