about summary refs log tree commit diff
path: root/doc/manual
diff options
context:
space:
mode:
authorzimbatm <zimbatm@zimbatm.com>2018-03-17T21·25+0000
committerzimbatm <zimbatm@zimbatm.com>2018-03-17T21·29+0000
commit43bef1b82c4a06a916b99643adaf398b04e18870 (patch)
tree0a0613629090011d57c7470e8657c65a264ab258 /doc/manual
parentfef8ebf51d8f190932a134186f775d57d1ccf054 (diff)
doc: document the min-free and max-free options
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/command-ref/conf-file.xml17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/manual/command-ref/conf-file.xml b/doc/manual/command-ref/conf-file.xml
index ab83f671a746..4a94b9355582 100644
--- a/doc/manual/command-ref/conf-file.xml
+++ b/doc/manual/command-ref/conf-file.xml
@@ -406,6 +406,12 @@ builtins.fetchurl {
 
   </varlistentry>
 
+  <varlistentry xml:id="conf-max-free"><term><literal>max-free</literal></term>
+
+    <listitem><para>This option defines after how many free bytes to stop collecting
+    garbage once the <literal>min-free</literal> condition gets triggered.</para></listitem>
+
+  </varlistentry>
 
   <varlistentry xml:id="conf-max-jobs"><term><literal>max-jobs</literal></term>
 
@@ -440,6 +446,17 @@ builtins.fetchurl {
 
   </varlistentry>
 
+  <varlistentry xml:id="conf-min-free"><term><literal>min-free</literal></term>
+
+    <listitem>
+      <para>When the disk reaches <literal>min-free</literal> bytes of free disk space during a build, nix
+        will start to garbage-collection until <literal>max-free</literal> bytes are available on the disk.
+        A value of <literal>0</literal> (the default) means that this feature is disabled.</para>
+      </para>
+    </listitem>
+
+  </varlistentry>
+
 
   <varlistentry xml:id="conf-netrc-file"><term><literal>netrc-file</literal></term>