re-order the options using the alphabetical order and improve the example in the positive lookup case

This commit is contained in:
AmineChikhaoui 2018-04-03 11:33:39 +01:00
parent 86930ed414
commit 33b08899d5
No known key found for this signature in database
GPG key ID: C0C8C84C15BCCD1C

View file

@ -456,6 +456,18 @@ builtins.fetchurl {
</varlistentry>
<varlistentry xml:id="conf-negative-disk-cache-ttl"><term><literal>negative-disk-cache-ttl</literal></term>
<listitem>
<para>The TTL in seconds for negative lookups. If a store path is
queried from a substituter but was not found, there will be a
negative lookup cached in the local disk cache database for the
specified duration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="conf-netrc-file"><term><literal>netrc-file</literal></term>
@ -511,6 +523,23 @@ password <replaceable>my-password</replaceable>
</varlistentry>
<varlistentry xml:id="conf-positive-disk-cache-ttl"><term><literal>positive-disk-cache-ttl</literal></term>
<listitem>
<para>The TTL in seconds for positive lookups. If a store path is
queried from a substituter, the result of the query will be cached
in the local disk cache database including some of the NAR
metadata. The default TTL is a month, setting a shorter TTL for
positive lookups can be useful for binary caches that have
frequent garbage collection, in which case having a more frequent
cache invalidation would prevent trying to pull the path again and
failing with a hash mismatch if the build isn't reproducible.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="conf-pre-build-hook"><term><literal>pre-build-hook</literal></term>
@ -788,31 +817,6 @@ password <replaceable>my-password</replaceable>
</varlistentry>
<varlistentry xml:id="conf-negative-disk-cache-ttl"><term><literal>negative-disk-cache-ttl</literal></term>
<listitem>
<para>The TTL in seconds for negative lookups. If a store path is queried from a substituer but
was not found, there will be a negative lookup cached in the local disk cache database for the specified
duration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="conf-positive-disk-cache-ttl"><term><literal>positive-disk-cache-ttl</literal></term>
<listitem>
<para>The TTL in seconds for positive lookups. If a store path is queried from a substituer, the result of
the query will be cached in the local disk cache database including some of the NAR metadata. Setting a TTL
for positive lookups can be useful in case of builds that aren't reproducible, in which case having a more
frequent cache invalidation would prevent hash mismatch issues.</para>
</listitem>
</varlistentry>
</variablelist>
</para>