1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2024-09-20 11:11:03 -04:00

reformat system-features setting documentation

This commit is contained in:
Valentin Gagarin 2023-07-17 11:28:27 +02:00
parent feb01b22ed
commit 493ddf617f

View file

@ -689,19 +689,21 @@ public:
getDefaultSystemFeatures(), getDefaultSystemFeatures(),
"system-features", "system-features",
R"( R"(
A set of system features supported by this machine, e.g. `kvm`. A set of system features supported by this machine.
Derivations can express a dependency on such features through the Derivations can express a dependency on such features through the derivation attribute `requiredSystemFeatures`.
derivation attribute `requiredSystemFeatures`. For example, the
attribute For example, the attribute
requiredSystemFeatures = [ "kvm" ]; requiredSystemFeatures = [ "kvm" ];
ensures that the derivation can only be built on a machine with the ensures that the derivation can only be built on a machine with the `kvm` feature.
`kvm` feature.
This setting by default includes `kvm` if `/dev/kvm` is accessible, This setting by default includes
and the pseudo-features `nixos-test`, `benchmark` and `big-parallel` - `kvm` if `/dev/kvm` is accessible
that are used in Nixpkgs to route builds to specific machines. - historical pseudo-features for backwards compatibility, used in Nixpkgs to route Hydra builds to specific machines
- `nixos-test`
- `benchmark`
- `big-parallel`
)", {}, false}; )", {}, false};
Setting<Strings> substituters{ Setting<Strings> substituters{