diff --git a/nixos/modules/tasks/encrypted-devices.nix b/nixos/modules/tasks/encrypted-devices.nix
index 06117d19af46..7837a34b4984 100644
--- a/nixos/modules/tasks/encrypted-devices.nix
+++ b/nixos/modules/tasks/encrypted-devices.nix
@@ -16,33 +16,33 @@ let
enable = mkOption {
default = false;
type = types.bool;
- description = "The block device is backed by an encrypted one, adds this device as a initrd luks entry.";
+ description = lib.mdDoc "The block device is backed by an encrypted one, adds this device as a initrd luks entry.";
};
blkDev = mkOption {
default = null;
example = "/dev/sda1";
type = types.nullOr types.str;
- description = "Location of the backing encrypted device.";
+ description = lib.mdDoc "Location of the backing encrypted device.";
};
label = mkOption {
default = null;
example = "rootfs";
type = types.nullOr types.str;
- description = "Label of the unlocked encrypted device. Set fileSystems.<name?>.device to /dev/mapper/<label> to mount the unlocked device.";
+ description = lib.mdDoc "Label of the unlocked encrypted device. Set `fileSystems..device` to `/dev/mapper/` to mount the unlocked device.";
};
keyFile = mkOption {
default = null;
example = "/mnt-root/root/.swapkey";
type = types.nullOr types.str;
- description = ''
+ description = lib.mdDoc ''
Path to a keyfile used to unlock the backing encrypted
device. At the time this keyfile is accessed, the
- neededForBoot filesystems (see
- fileSystems.<name?>.neededForBoot )
- will have been mounted under /mnt-root ,
+ `neededForBoot` filesystems (see
+ `fileSystems..neededForBoot`)
+ will have been mounted under `/mnt-root`,
so the keyfile path should usually start with "/mnt-root/".
'';
};
diff --git a/nixos/modules/tasks/snapraid.nix b/nixos/modules/tasks/snapraid.nix
index c8dde5b48993..634ffa031113 100644
--- a/nixos/modules/tasks/snapraid.nix
+++ b/nixos/modules/tasks/snapraid.nix
@@ -14,7 +14,7 @@ in
d2 = "/mnt/disk2/";
d3 = "/mnt/disk3/";
};
- description = "SnapRAID data disks.";
+ description = lib.mdDoc "SnapRAID data disks.";
type = attrsOf str;
};
parityFiles = mkOption {
@@ -27,7 +27,7 @@ in
"/mnt/diskt/snapraid.5-parity"
"/mnt/disku/snapraid.6-parity"
];
- description = "SnapRAID parity files.";
+ description = lib.mdDoc "SnapRAID parity files.";
type = listOf str;
};
contentFiles = mkOption {
@@ -37,46 +37,46 @@ in
"/mnt/disk1/snapraid.content"
"/mnt/disk2/snapraid.content"
];
- description = "SnapRAID content list files.";
+ description = lib.mdDoc "SnapRAID content list files.";
type = listOf str;
};
exclude = mkOption {
default = [ ];
example = [ "*.unrecoverable" "/tmp/" "/lost+found/" ];
- description = "SnapRAID exclude directives.";
+ description = lib.mdDoc "SnapRAID exclude directives.";
type = listOf str;
};
touchBeforeSync = mkOption {
default = true;
example = false;
- description =
- "Whether snapraid touch should be run before snapraid sync .";
+ description = lib.mdDoc
+ "Whether {command}`snapraid touch` should be run before {command}`snapraid sync`.";
type = bool;
};
sync.interval = mkOption {
default = "01:00";
example = "daily";
- description = "How often to run snapraid sync .";
+ description = lib.mdDoc "How often to run {command}`snapraid sync`.";
type = str;
};
scrub = {
interval = mkOption {
default = "Mon *-*-* 02:00:00";
example = "weekly";
- description = "How often to run snapraid scrub .";
+ description = lib.mdDoc "How often to run {command}`snapraid scrub`.";
type = str;
};
plan = mkOption {
default = 8;
example = 5;
- description =
- "Percent of the array that should be checked by snapraid scrub .";
+ description = lib.mdDoc
+ "Percent of the array that should be checked by {command}`snapraid scrub`.";
type = int;
};
olderThan = mkOption {
default = 10;
example = 20;
- description =
+ description = lib.mdDoc
"Number of days since data was last scrubbed before it can be scrubbed again.";
type = int;
};
@@ -90,7 +90,7 @@ in
autosave 500
pool /pool
'';
- description = "Extra config options for SnapRAID.";
+ description = lib.mdDoc "Extra config options for SnapRAID.";
type = lines;
};
};
diff --git a/nixos/modules/tasks/swraid.nix b/nixos/modules/tasks/swraid.nix
index 0b53a6d152d0..26d6bd914d5e 100644
--- a/nixos/modules/tasks/swraid.nix
+++ b/nixos/modules/tasks/swraid.nix
@@ -10,7 +10,7 @@ in {
};
mdadmConf = lib.mkOption {
- description = "Contents of /etc/mdadm.conf in initrd.";
+ description = lib.mdDoc "Contents of {file}`/etc/mdadm.conf` in initrd.";
type = lib.types.lines;
default = "";
};