Explain fetchTarball timeout behavior in the doc #2164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
edolstra
reviewed
May 16, 2018
doc/manual/expressions/builtins.xml
Outdated
| <para>The fetched tarball is chached for a certain amount of time | ||
| (1 hour by default) in <literal>~/.cache/nix/tarballs/</literal>. | ||
| You can change the cache timeout either in command line with | ||
| <literal>--option tarball-ttl <number of seconds></literal> or |
There was a problem hiding this comment.
<number of seconds> is not valid XML. You should do something like <replaceable>ttl</replaceable>.
edolstra
reviewed
May 16, 2018
doc/manual/expressions/builtins.xml
Outdated
| Note that when obtaining the hash with <varname>nix-prefetch-url | ||
| <para>The fetched tarball is chached for a certain amount of time | ||
| (1 hour by default) in <literal>~/.cache/nix/tarballs/</literal>. | ||
| You can change the cache timeout either in command line with |
edolstra
reviewed
May 16, 2018
doc/manual/expressions/builtins.xml
Outdated
| You can change the cache timeout either in command line with | ||
| <literal>--option tarball-ttl <number of seconds></literal> or | ||
| in the Nix configuration file with tarball-ttl | ||
| <literal><number of seconds to cache></literal> |
grahamc
approved these changes
May 29, 2018
doc/manual/expressions/builtins.xml
Outdated
| @@ -280,8 +280,15 @@ with import (fetchTarball https://github.com/NixOS/nixpkgs-channels/archive/nixo | |||
|
|
|||
| stdenv.mkDerivation { … } | |||
| </programlisting> | |||
|
|
|||
| Note that when obtaining the hash with <varname>nix-prefetch-url | |||
| <para>The fetched tarball is chached for a certain amount of time | |||
doc/manual/expressions/builtins.xml
Outdated
|
|
||
| Note that when obtaining the hash with <varname>nix-prefetch-url | ||
| <para>The fetched tarball is chached for a certain amount of time | ||
| (1 hour by default) in <literal>~/.cache/nix/tarballs/</literal>. |
There was a problem hiding this comment.
(a nit, you don't have to change this:) <literal> could be <filename>.
doc/manual/expressions/builtins.xml
Outdated
| <para>The fetched tarball is chached for a certain amount of time | ||
| (1 hour by default) in <literal>~/.cache/nix/tarballs/</literal>. | ||
| You can change the cache timeout either on the command line with | ||
| <literal>--option tarball-ttl <replaceable>number of seconds</replaceable></literal> or |
There was a problem hiding this comment.
(a nit, you don't have to change this:) <literal> could be <option>, same with the following <literal>.
|
Done! Thanks for the review :) |
grahamc
reviewed
May 29, 2018
doc/manual/expressions/builtins.xml
Outdated
| @@ -280,8 +280,15 @@ with import (fetchTarball https://github.com/NixOS/nixpkgs-channels/archive/nixo | |||
|
|
|||
| stdenv.mkDerivation { … } | |||
| </programlisting> | |||
| <para>The fetched tarball is cached for a certain amount of time | |||
There was a problem hiding this comment.
Oops, one more thing: there also needs to be a </para> before this opening <para>.
grahamc
force-pushed
the
doc-fetchTarball-timout
branch
from
50f3375
to
8dd2e28
Compare
|
There was one minor problem left, where you committed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just add some doc on the timeout mechanism of the fetchTarball builtins (because I only find this information on the IRC :))