nixos/hardware: invariant option docs MD conversions

This commit is contained in:
pennae 2022-07-19 15:05:45 +02:00
parent 8a79dfd94a
commit 4dd84a34db
2 changed files with 9 additions and 9 deletions

View file

@ -6,13 +6,13 @@ let
in in
{ {
options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption { options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption {
description = '' description = lib.mdDoc ''
Whether to enable backward compatibility for SGX software build for the Whether to enable backward compatibility for SGX software build for the
out-of-tree Intel SGX DCAP driver. out-of-tree Intel SGX DCAP driver.
Creates symbolic links for the SGX devices <literal>/dev/sgx_enclave</literal> Creates symbolic links for the SGX devices `/dev/sgx_enclave`
and <literal>/dev/sgx_provision</literal> to make them available as and `/dev/sgx_provision` to make them available as
<literal>/dev/sgx/enclave</literal> and <literal>/dev/sgx/provision</literal>, `/dev/sgx/enclave` and `/dev/sgx/provision`,
respectively. respectively.
''; '';
type = types.bool; type = types.bool;
@ -22,17 +22,17 @@ in
options.hardware.cpu.intel.sgx.provision = { options.hardware.cpu.intel.sgx.provision = {
enable = mkEnableOption "access to the Intel SGX provisioning device"; enable = mkEnableOption "access to the Intel SGX provisioning device";
user = mkOption { user = mkOption {
description = "Owner to assign to the SGX provisioning device."; description = lib.mdDoc "Owner to assign to the SGX provisioning device.";
type = types.str; type = types.str;
default = "root"; default = "root";
}; };
group = mkOption { group = mkOption {
description = "Group to assign to the SGX provisioning device."; description = lib.mdDoc "Group to assign to the SGX provisioning device.";
type = types.str; type = types.str;
default = defaultPrvGroup; default = defaultPrvGroup;
}; };
mode = mkOption { mode = mkOption {
description = "Mode to set for the SGX provisioning device."; description = lib.mdDoc "Mode to set for the SGX provisioning device.";
type = types.str; type = types.str;
default = "0660"; default = "0660";
}; };

View file

@ -15,9 +15,9 @@ in {
sleep = mkOption { sleep = mkOption {
type = types.nullOr types.int; type = types.nullOr types.int;
default = null; default = null;
description = '' description = lib.mdDoc ''
How many milliseconds ksmd should sleep between scans. How many milliseconds ksmd should sleep between scans.
Setting it to <literal>null</literal> uses the kernel's default time. Setting it to `null` uses the kernel's default time.
''; '';
}; };
}; };