From c682532fceff80170e427a4383ae6e474165dd2b Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Sun, 6 Jun 2021 13:19:33 -0700 Subject: [PATCH] doc/functions/prefer-remote-fetch: convert to CommonMark --- doc/functions.xml | 2 +- doc/functions/prefer-remote-fetch.section.md | 17 ++++++++++++++++ doc/functions/prefer-remote-fetch.xml | 21 -------------------- 3 files changed, 18 insertions(+), 22 deletions(-) create mode 100644 doc/functions/prefer-remote-fetch.section.md delete mode 100644 doc/functions/prefer-remote-fetch.xml diff --git a/doc/functions.xml b/doc/functions.xml index f2d06402317..dd91d705aa9 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -9,6 +9,6 @@ - + diff --git a/doc/functions/prefer-remote-fetch.section.md b/doc/functions/prefer-remote-fetch.section.md new file mode 100644 index 00000000000..8760c100224 --- /dev/null +++ b/doc/functions/prefer-remote-fetch.section.md @@ -0,0 +1,17 @@ +# prefer-remote-fetch overlay {#sec-prefer-remote-fetch} + +`prefer-remote-fetch` 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: + +```nix +self: super: + (super.prefer-remote-fetch self super) +``` + +A full configuration example for that sets the overlay up for your own account, could look like this + +```ShellSession +$ mkdir ~/.config/nixpkgs/overlays/ +$ cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix < - prefer-remote-fetch overlay - - - prefer-remote-fetch 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: - -self: super: - (super.prefer-remote-fetch self super) - - A full configuration example for that sets the overlay up for your own account, could look like this - -$ mkdir ~/.config/nixpkgs/overlays/ -$ cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF - self: super: super.prefer-remote-fetch self super -EOF - - -