diff options
author | pennae <github@quasiparticle.net> | 2022-08-28 21:18:44 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-31 16:32:53 +0200 |
commit | ef176dcf7e76c3639571d7c6051246c8fbadf12a (patch) | |
tree | 3bb88ef3515ace2ad477e245bf347213c6055464 /nixos/modules/tasks | |
parent | 5a643387ec1234c5f25357f2ff962a84895436f6 (diff) |
nixos/*: automatically convert option descriptions
conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
Diffstat (limited to 'nixos/modules/tasks')
-rw-r--r-- | nixos/modules/tasks/filesystems/btrfs.nix | 2 | ||||
-rw-r--r-- | nixos/modules/tasks/filesystems/zfs.nix | 10 | ||||
-rw-r--r-- | nixos/modules/tasks/lvm.nix | 6 | ||||
-rw-r--r-- | nixos/modules/tasks/powertop.nix | 2 | ||||
-rw-r--r-- | nixos/modules/tasks/snapraid.nix | 2 |
5 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/tasks/filesystems/btrfs.nix b/nixos/modules/tasks/filesystems/btrfs.nix index 32bfaba95c2e4..bd85a1f8d1f3c 100644 --- a/nixos/modules/tasks/filesystems/btrfs.nix +++ b/nixos/modules/tasks/filesystems/btrfs.nix @@ -19,7 +19,7 @@ in # One could also do regular btrfs balances, but that shouldn't be necessary # during normal usage and as long as the filesystems aren't filled near capacity services.btrfs.autoScrub = { - enable = mkEnableOption "regular btrfs scrub"; + enable = mkEnableOption (lib.mdDoc "regular btrfs scrub"); fileSystems = mkOption { type = types.listOf types.path; diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix index 098f9031628da..96222f3b4f645 100644 --- a/nixos/modules/tasks/filesystems/zfs.nix +++ b/nixos/modules/tasks/filesystems/zfs.nix @@ -277,12 +277,12 @@ in forceImportAll = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Forcibly import all ZFS pool(s). - If you set this option to <literal>false</literal> and NixOS subsequently fails to + If you set this option to `false` and NixOS subsequently fails to import your non-root ZFS pool(s), you should manually import each pool with - "zpool import -f <pool-name>", and then reboot. You should only need to do + "zpool import -f \<pool-name\>", and then reboot. You should only need to do this once. ''; }; @@ -399,7 +399,7 @@ in }; services.zfs.autoScrub = { - enable = mkEnableOption "periodic scrubbing of ZFS pools"; + enable = mkEnableOption (lib.mdDoc "periodic scrubbing of ZFS pools"); interval = mkOption { default = "Sun, 02:00"; @@ -440,7 +440,7 @@ in }; services.zfs.zed = { - enableMail = mkEnableOption "ZED's ability to send emails" // { + enableMail = mkEnableOption (lib.mdDoc "ZED's ability to send emails") // { default = cfgZfs.package.enableMail; defaultText = literalExpression "config.${optZfs.package}.enableMail"; }; diff --git a/nixos/modules/tasks/lvm.nix b/nixos/modules/tasks/lvm.nix index 2f98e3e7da5b2..48b0901e24289 100644 --- a/nixos/modules/tasks/lvm.nix +++ b/nixos/modules/tasks/lvm.nix @@ -16,9 +16,9 @@ in { Defaults to pkgs.lvm2, pkgs.lvm2_dmeventd if dmeventd or pkgs.lvm2_vdo if vdo is enabled. ''; }; - dmeventd.enable = mkEnableOption "the LVM dmevent daemon"; - boot.thin.enable = mkEnableOption "support for booting from ThinLVs"; - boot.vdo.enable = mkEnableOption "support for booting from VDOLVs"; + dmeventd.enable = mkEnableOption (lib.mdDoc "the LVM dmevent daemon"); + boot.thin.enable = mkEnableOption (lib.mdDoc "support for booting from ThinLVs"); + boot.vdo.enable = mkEnableOption (lib.mdDoc "support for booting from VDOLVs"); }; options.boot.initrd.services.lvm.enable = (mkEnableOption "enable booting from LVM2 in the initrd") // { diff --git a/nixos/modules/tasks/powertop.nix b/nixos/modules/tasks/powertop.nix index e8064f9fa80c6..3839b7a4260e0 100644 --- a/nixos/modules/tasks/powertop.nix +++ b/nixos/modules/tasks/powertop.nix @@ -7,7 +7,7 @@ let in { ###### interface - options.powerManagement.powertop.enable = mkEnableOption "powertop auto tuning on startup"; + options.powerManagement.powertop.enable = mkEnableOption (lib.mdDoc "powertop auto tuning on startup"); ###### implementation diff --git a/nixos/modules/tasks/snapraid.nix b/nixos/modules/tasks/snapraid.nix index 634ffa0311134..243d25f884237 100644 --- a/nixos/modules/tasks/snapraid.nix +++ b/nixos/modules/tasks/snapraid.nix @@ -6,7 +6,7 @@ let cfg = config.snapraid; in { options.snapraid = with types; { - enable = mkEnableOption "SnapRAID"; + enable = mkEnableOption (lib.mdDoc "SnapRAID"); dataDisks = mkOption { default = { }; example = { |