doc/functions/prefer-remote-fetch: convert to CommonMark
This commit is contained in:
parent
4cbe74ea20
commit
c682532fce
|
@ -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>
|
||||
|
|
17
doc/functions/prefer-remote-fetch.section.md
Normal file
17
doc/functions/prefer-remote-fetch.section.md
Normal file
|
@ -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
|
||||
```
|
|
@ -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>
|
Loading…
Reference in a new issue