From faa3e54fe0a926dee6e04c646881bdb627494300 Mon Sep 17 00:00:00 2001 From: Profpatsch Date: Fri, 29 Nov 2019 16:59:08 +0100 Subject: [PATCH] doc/builders/trivial-builders: added runCommandLocal docs The link in the note points to the `id` added in https://github.com/NixOS/nix/pull/3255, so it might take some time to start working correctly. --- doc/builders/trivial-builders.xml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/builders/trivial-builders.xml b/doc/builders/trivial-builders.xml index df0e38da1aa..18d1f9701a4 100644 --- a/doc/builders/trivial-builders.xml +++ b/doc/builders/trivial-builders.xml @@ -50,6 +50,19 @@ + + + runCommandLocal, runCommandCCLocal + + + + Variants of runCommand and runCommandCC that force 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 roundrip and can speed up a build. + + + This sets allowSubstitutes to false, so only use runCommandLocal if you are certain the user will always have a builder for the system of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the system is usually the same as builtins.currentSystem. + + + writeTextFile, writeText, writeTextDir, writeScript, writeScriptBin