diff options
Diffstat (limited to 'nixos/modules/config/swap.nix')
-rw-r--r-- | nixos/modules/config/swap.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/config/swap.nix b/nixos/modules/config/swap.nix index 21046d6f1697..a606ebd76759 100644 --- a/nixos/modules/config/swap.nix +++ b/nixos/modules/config/swap.nix @@ -14,7 +14,7 @@ let enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Encrypt swap device with a random key. This way you won't have a persistent swap device. WARNING: Don't try to hibernate when you have at least one swap partition with @@ -31,7 +31,7 @@ let default = "aes-xts-plain64"; example = "serpent-xts-plain64"; type = types.str; - description = lib.mdDoc '' + description = '' Use specified cipher for randomEncryption. Hint: Run "cryptsetup benchmark" to see which one is fastest on your machine. @@ -42,7 +42,7 @@ let default = null; example = "512"; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' Set the encryption key size for the plain device. If not specified, the amount of data to read from `source` will be @@ -56,7 +56,7 @@ let default = null; example = "4096"; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' Set the sector size for the plain encrypted device type. If not specified, the default sector size is determined from the @@ -70,7 +70,7 @@ let default = "/dev/urandom"; example = "/dev/random"; type = types.str; - description = lib.mdDoc '' + description = '' Define the source of randomness to obtain a random key for encryption. ''; }; @@ -78,7 +78,7 @@ let allowDiscards = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. @@ -95,13 +95,13 @@ let device = mkOption { example = "/dev/sda3"; type = types.nonEmptyStr; - description = lib.mdDoc "Path of the device or swap file."; + description = "Path of the device or swap file."; }; label = mkOption { example = "swap"; type = types.str; - description = lib.mdDoc '' + description = '' Label of the device. Can be used instead of {var}`device`. ''; }; @@ -110,7 +110,7 @@ let default = null; example = 2048; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' If this option is set, ‘device’ is interpreted as the path of a swapfile that will be created automatically with the indicated size (in megabytes). @@ -121,7 +121,7 @@ let default = null; example = 2048; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' Specify the priority of the swap device. Priority is a value between 0 and 32767. Higher numbers indicate higher priority. null lets the kernel choose a priority, which will show up as a negative value. @@ -136,7 +136,7 @@ let source = "/dev/random"; }; type = types.coercedTo types.bool randomEncryptionCoerce (types.submodule randomEncryptionOpts); - description = lib.mdDoc '' + description = '' Encrypt swap device with a random key. This way you won't have a persistent swap device. HINT: run "cryptsetup benchmark" to test cipher performance on your machine. @@ -155,7 +155,7 @@ let default = null; example = "once"; type = types.nullOr (types.enum ["once" "pages" "both" ]); - description = lib.mdDoc '' + description = '' Specify the discard policy for the swap device. If "once", then the whole swap space is discarded at swapon invocation. If "pages", asynchronous discard on freed pages is performed, before returning to @@ -168,7 +168,7 @@ let default = [ "defaults" ]; example = [ "nofail" ]; type = types.listOf types.nonEmptyStr; - description = lib.mdDoc '' + description = '' Options used to mount the swap. ''; }; @@ -209,7 +209,7 @@ in { device = "/var/swapfile"; } { label = "bigswap"; } ]; - description = lib.mdDoc '' + description = '' The swap devices and swap files. These must have been initialised using {command}`mkswap`. Each element should be an attribute set specifying either the path of the |