diff options
| author | Ryan Mulligan <ryan@ryantm.com> | 2021-06-06 13:19:33 -0700 |
|---|---|---|
| committer | Ryan Mulligan <ryan@ryantm.com> | 2021-06-07 20:18:39 -0700 |
| commit | c682532fceff80170e427a4383ae6e474165dd2b (patch) | |
| tree | fc2b857b99d9d1946aa5ca2a24139efcbb727460 /doc | |
| parent | 4cbe74ea209a8a5ce1e6941bd130dfe81689132b (diff) | |
| download | nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar.gz nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar.bz2 nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar.lz nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar.xz nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.tar.zst nixpkgs-c682532fceff80170e427a4383ae6e474165dd2b.zip | |
doc/functions/prefer-remote-fetch: convert to CommonMark
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/functions.xml | 2 | ||||
| -rw-r--r-- | doc/functions/prefer-remote-fetch.section.md | 17 | ||||
| -rw-r--r-- | doc/functions/prefer-remote-fetch.xml | 21 |
3 files changed, 18 insertions, 22 deletions
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 @@ <xi:include href="functions/library.xml" /> <xi:include href="functions/generators.xml" /> <xi:include href="functions/debug.section.xml" /> - <xi:include href="functions/prefer-remote-fetch.xml" /> + <xi:include href="functions/prefer-remote-fetch.section.xml" /> <xi:include href="functions/nix-gitignore.section.xml" /> </chapter> 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 <<EOF + self: super: super.prefer-remote-fetch self super +EOF +``` diff --git a/doc/functions/prefer-remote-fetch.xml b/doc/functions/prefer-remote-fetch.xml deleted file mode 100644 index 94d25d3d3ae..00000000000 --- a/doc/functions/prefer-remote-fetch.xml +++ /dev/null @@ -1,21 +0,0 @@ -<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> |