aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/command-ref/conf-file.xml
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2018-09-28 15:57:27 +0200
committerEelco Dolstra <edolstra@gmail.com>2018-09-28 16:10:27 +0200
commit1e7b8deea7e052ed9ebf47d1411bcaf542054b41 (patch)
tree4e04f265227ac7fcd9b52940758835e576c2978a /doc/manual/command-ref/conf-file.xml
parent7ae7a38c9a7d0a5679e65c8213cd7b58dfdc1c52 (diff)
Check requiredSystemFeatures for local builds
For example, this prevents a "kvm" build on machines that don't have KVM. Fixes #2012.
Diffstat (limited to 'doc/manual/command-ref/conf-file.xml')
-rw-r--r--doc/manual/command-ref/conf-file.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/manual/command-ref/conf-file.xml b/doc/manual/command-ref/conf-file.xml
index fd09883be..e9947ebc6 100644
--- a/doc/manual/command-ref/conf-file.xml
+++ b/doc/manual/command-ref/conf-file.xml
@@ -757,6 +757,33 @@ password <replaceable>my-password</replaceable>
</varlistentry>
+ <varlistentry xml:id="conf-system-features"><term><literal>system-features</literal></term>
+
+ <listitem><para>A set of system “features” supported by this
+ machine, e.g. <literal>kvm</literal>. Derivations can express a
+ dependency on such features through the derivation attribute
+ <varname>requiredSystemFeatures</varname>. For example, the
+ attribute
+
+<programlisting>
+requiredSystemFeatures = [ "kvm" ];
+</programlisting>
+
+ ensures that the derivation can only be built on a machine with
+ the <literal>kvm</literal> feature.</para>
+
+ <para>This setting by default includes <literal>kvm</literal> if
+ <filename>/dev/kvm</filename> is accessible, and the
+ pseudo-features <literal>nixos-test</literal>,
+ <literal>benchmark</literal> and <literal>big-parallel</literal>
+ that are used in Nixpkgs to route builds to specific
+ machines.</para>
+
+ </listitem>
+
+ </varlistentry>
+
+
<varlistentry xml:id="conf-timeout"><term><literal>timeout</literal></term>
<listitem>