diff options
author | Jörg Thalheim <joerg@thalheim.io> | 2018-12-31 08:10:28 +0100 |
---|---|---|
committer | Jörg Thalheim <joerg@thalheim.io> | 2019-01-18 14:41:10 +0000 |
commit | eac6797380af1f0927ab683e2375429826d34e76 (patch) | |
tree | 4d292ad4c8eac2df780174bbcbe143802be68de9 /doc/functions | |
parent | 487d2a7ccdf520e60b77809681e4ca377a7b741d (diff) | |
download | nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar.gz nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar.bz2 nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar.lz nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar.xz nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.tar.zst nixpkgs-eac6797380af1f0927ab683e2375429826d34e76.zip |
prefer-fetch-remote: an overlay to fetch on remote builders
This is useful when running tools like NixOps or nix-review on workstations where the upload to the builder is significantly slower then downloading the source on the builder itself.
Diffstat (limited to 'doc/functions')
-rw-r--r-- | doc/functions/prefer-remote-fetch.xml | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/functions/prefer-remote-fetch.xml b/doc/functions/prefer-remote-fetch.xml new file mode 100644 index 00000000000..85f08f4eae1 --- /dev/null +++ b/doc/functions/prefer-remote-fetch.xml @@ -0,0 +1,27 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/xinclude" + xml:id="sec-prefer-remote-fetch"> + <title>prefer-remote-fetch overlay</title> + + <para> + <function>prefer-remote-fetch</function> is an overlay that download sources + on remote builder. This is useful when the evaluating machine has a slow + upload while the builder can fetch faster directly from the source. + To use it, put the following snippet as a new overlay: + <programlisting> + self: super: + (super.prefer-remote-fetch self super) + </programlisting> + + A full configuration example for that sets the overlay up for your own account, + could look like this + + <programlisting> + $ mkdir ~/.config/nixpkgs/overlays/ + $ cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF + self: super: super.prefer-remote-fetch self super + EOF + </programlisting> + </para> +</section> |