From 4dd84a34db0eb06189d44264e8cad2bf7faed6e5 Mon Sep 17 00:00:00 2001 From: pennae Date: Tue, 19 Jul 2022 15:05:45 +0200 Subject: [PATCH] nixos/hardware: invariant option docs MD conversions --- nixos/modules/hardware/cpu/intel-sgx.nix | 14 +++++++------- nixos/modules/hardware/ksm.nix | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/nixos/modules/hardware/cpu/intel-sgx.nix b/nixos/modules/hardware/cpu/intel-sgx.nix index 1355ee753f0d..76664133a08f 100644 --- a/nixos/modules/hardware/cpu/intel-sgx.nix +++ b/nixos/modules/hardware/cpu/intel-sgx.nix @@ -6,13 +6,13 @@ let in { options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable backward compatibility for SGX software build for the out-of-tree Intel SGX DCAP driver. - Creates symbolic links for the SGX devices /dev/sgx_enclave - and /dev/sgx_provision to make them available as - /dev/sgx/enclave and /dev/sgx/provision, + Creates symbolic links for the SGX devices `/dev/sgx_enclave` + and `/dev/sgx_provision` to make them available as + `/dev/sgx/enclave` and `/dev/sgx/provision`, respectively. ''; type = types.bool; @@ -22,17 +22,17 @@ in options.hardware.cpu.intel.sgx.provision = { enable = mkEnableOption "access to the Intel SGX provisioning device"; 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; default = "root"; }; 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; default = defaultPrvGroup; }; 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; default = "0660"; }; diff --git a/nixos/modules/hardware/ksm.nix b/nixos/modules/hardware/ksm.nix index 829c3532c459..ba7a1c12169f 100644 --- a/nixos/modules/hardware/ksm.nix +++ b/nixos/modules/hardware/ksm.nix @@ -15,9 +15,9 @@ in { sleep = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' How many milliseconds ksmd should sleep between scans. - Setting it to null uses the kernel's default time. + Setting it to `null` uses the kernel's default time. ''; }; };