diff options
Diffstat (limited to 'nixpkgs/doc/functions/prefer-remote-fetch.xml')
| -rw-r--r-- | nixpkgs/doc/functions/prefer-remote-fetch.xml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/nixpkgs/doc/functions/prefer-remote-fetch.xml b/nixpkgs/doc/functions/prefer-remote-fetch.xml new file mode 100644 index 000000000000..94d25d3d3aeb --- /dev/null +++ b/nixpkgs/doc/functions/prefer-remote-fetch.xml @@ -0,0 +1,21 @@ +<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 +<screen> +<prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/ +<prompt>$ </prompt>cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF + self: super: super.prefer-remote-fetch self super +EOF +</screen> + </para> +</section> |