Add support for the `build-timeout' and `--timeout' options.

1 files changed, 17 insertions, 0 deletions

diff --git a/doc/manual/conf-file.xml b/doc/manual/conf-file.xml
index cb47b99418b6..44a7ac3885a8 100644
--- a/doc/manual/conf-file.xml
+++ b/doc/manual/conf-file.xml
@@ -134,6 +134,23 @@ env-keep-derivations = false
 
     </listitem>
 
+  <varlistentry xml:id="conf-build-timeout"><term><literal>build-timeout</literal></term>
+
+    <listitem>
+
+      <para>This option defines the maximum number of seconds that a
+      builder can run.  This is useful (for instance in a automated
+      build system) to catch builds that are stuck in an infinite loop
+      but keep writing to their standard output or standard error.  It
+      can be overriden using the <option
+      linkend="opt-timeout">--timeout</option> command line
+      switch.</para>
+
+      <para>The value <literal>0</literal> means that there is no
+      timeout.  This is also the default.</para>
+
+    </listitem>
+
   </varlistentry>