diff options
author | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-12 23:23:26 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-12 23:23:26 +0200 |
commit | 50f9b3107a09ed35bbf3f9ab36ad2683619debd2 (patch) | |
tree | 5d6e8d31e2e75a37adbccb6d7dfe02d3dabde7b3 /nixos/modules/tasks | |
parent | a253a7da71db6a0a1d06cbbbe09fb456d84047ce (diff) | |
parent | 087472b1e5230ffc8ba642b1e4f9218adf4634a2 (diff) |
Merge pull request #185474 from pennae/option-docs-md
nixos/*: more options md conversion
Diffstat (limited to 'nixos/modules/tasks')
-rw-r--r-- | nixos/modules/tasks/auto-upgrade.nix | 10 | ||||
-rw-r--r-- | nixos/modules/tasks/filesystems/btrfs.nix | 8 | ||||
-rw-r--r-- | nixos/modules/tasks/filesystems/zfs.nix | 10 | ||||
-rw-r--r-- | nixos/modules/tasks/network-interfaces.nix | 10 |
4 files changed, 15 insertions, 23 deletions
diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix index ca2690167830a..bfc5265518d26 100644 --- a/nixos/modules/tasks/auto-upgrade.nix +++ b/nixos/modules/tasks/auto-upgrade.nix @@ -77,13 +77,12 @@ in { type = types.str; default = "04:40"; example = "daily"; - description = '' + description = lib.mdDoc '' How often or when upgrade occurs. For most desktop and server systems a sufficient upgrade frequency is once a day. The format is described in - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. ''; }; @@ -102,12 +101,11 @@ in { default = "0"; type = types.str; example = "45min"; - description = '' + description = lib.mdDoc '' Add a randomized delay before each automatic upgrade. The delay will be chosen between zero and this value. This value must be a time span in the format specified by - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry> + {manpage}`systemd.time(7)` ''; }; diff --git a/nixos/modules/tasks/filesystems/btrfs.nix b/nixos/modules/tasks/filesystems/btrfs.nix index 4e5180f213535..32bfaba95c2e4 100644 --- a/nixos/modules/tasks/filesystems/btrfs.nix +++ b/nixos/modules/tasks/filesystems/btrfs.nix @@ -36,14 +36,12 @@ in default = "monthly"; type = types.str; example = "weekly"; - description = '' + description = lib.mdDoc '' Systemd calendar expression for when to scrub btrfs filesystems. The recommended period is a month but could be less - (<citerefentry><refentrytitle>btrfs-scrub</refentrytitle> - <manvolnum>8</manvolnum></citerefentry>). + ({manpage}`btrfs-scrub(8)`). See - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry> + {manpage}`systemd.time(7)` for more information on the syntax. ''; }; diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix index 1d661eae8275c..2ff6c1067c76d 100644 --- a/nixos/modules/tasks/filesystems/zfs.nix +++ b/nixos/modules/tasks/filesystems/zfs.nix @@ -388,13 +388,12 @@ in default = "weekly"; type = types.str; example = "daily"; - description = '' + description = lib.mdDoc '' How often we run trim. For most desktop and server systems a sufficient trimming frequency is once a week. The format is described in - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. ''; }; }; @@ -406,10 +405,9 @@ in default = "Sun, 02:00"; type = types.str; example = "daily"; - description = '' + description = lib.mdDoc '' Systemd calendar expression when to scrub ZFS pools. See - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. ''; }; diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index a462035329487..fabddece376b8 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -876,10 +876,9 @@ in primary = { port = 9001; local = { address = "192.0.2.1"; dev = "eth0"; }; }; backup = { port = 9002; }; }; - description = '' + description = lib.mdDoc '' This option allows you to configure Foo Over UDP and Generic UDP Encapsulation - endpoints. See <citerefentry><refentrytitle>ip-fou</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> for details. + endpoints. See {manpage}`ip-fou(8)` for details. ''; type = with types; attrsOf (submodule { options = { @@ -998,10 +997,9 @@ in options = { type = mkOption { type = enum [ "fou" "gue" ]; - description = '' + description = lib.mdDoc '' Selects encapsulation type. See - <citerefentry><refentrytitle>ip-link</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> for details. + {manpage}`ip-link(8)` for details. ''; }; |