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/filesystems | |
parent | 5a643387ec1234c5f25357f2ff962a84895436f6 (diff) | |
download | nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.gz nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.bz2 nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.lz nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.xz nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.zst nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.zip |
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/filesystems')
-rw-r--r-- | nixos/modules/tasks/filesystems/btrfs.nix | 2 | ||||
-rw-r--r-- | nixos/modules/tasks/filesystems/zfs.nix | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/tasks/filesystems/btrfs.nix b/nixos/modules/tasks/filesystems/btrfs.nix index 32bfaba95c2e..bd85a1f8d1f3 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 098f9031628d..96222f3b4f64 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"; }; |