diff options
Diffstat (limited to 'nixos/modules/tasks/auto-upgrade.nix')
-rw-r--r-- | nixos/modules/tasks/auto-upgrade.nix | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix index 54eee19dc77..46a30c53ea8 100644 --- a/nixos/modules/tasks/auto-upgrade.nix +++ b/nixos/modules/tasks/auto-upgrade.nix @@ -13,10 +13,10 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to periodically upgrade NixOS to the latest version. If enabled, a systemd timer will run - <literal>nixos-rebuild switch --upgrade</literal> once a + `nixos-rebuild switch --upgrade` once a day. ''; }; @@ -36,9 +36,9 @@ in { type = types.nullOr types.str; default = null; example = "github:kloenk/nix"; - description = '' + description = lib.mdDoc '' The Flake URI of the NixOS configuration to build. - Disables the option <option>system.autoUpgrade.channel</option>. + Disables the option {option}`system.autoUpgrade.channel`. ''; }; @@ -64,11 +64,11 @@ in { "extra-binary-caches" "http://my-cache.example.org/" ]; - description = '' - Any additional flags passed to <command>nixos-rebuild</command>. + description = lib.mdDoc '' + Any additional flags passed to {command}`nixos-rebuild`. If you are using flakes and use a local repo you can add - <command>[ "--update-input" "nixpkgs" "--commit-lock-file" ]</command> + {command}`[ "--update-input" "nixpkgs" "--commit-lock-file" ]` to update nixpkgs. ''; }; @@ -90,11 +90,11 @@ in { allowReboot = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Reboot the system into the new generation instead of a switch if the new generation uses a different kernel, kernel modules or initrd than the booted system. - See <option>rebootWindow</option> for configuring the times at which a reboot is allowed. + See {option}`rebootWindow` for configuring the times at which a reboot is allowed. ''; }; @@ -112,24 +112,24 @@ in { }; rebootWindow = mkOption { - description = '' + description = lib.mdDoc '' Define a lower and upper time value (in HH:MM format) which constitute a time window during which reboots are allowed after an upgrade. - This option only has an effect when <option>allowReboot</option> is enabled. - The default value of <literal>null</literal> means that reboots are allowed at any time. + This option only has an effect when {option}`allowReboot` is enabled. + The default value of `null` means that reboots are allowed at any time. ''; default = null; example = { lower = "01:00"; upper = "05:00"; }; type = with types; nullOr (submodule { options = { lower = mkOption { - description = "Lower limit of the reboot window"; + description = lib.mdDoc "Lower limit of the reboot window"; type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}"; example = "01:00"; }; upper = mkOption { - description = "Upper limit of the reboot window"; + description = lib.mdDoc "Upper limit of the reboot window"; type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}"; example = "05:00"; }; @@ -141,7 +141,7 @@ in { default = true; type = types.bool; example = false; - description = '' + description = lib.mdDoc '' Takes a boolean argument. If true, the time when the service unit was last triggered is stored on disk. When the timer is activated, the service unit is triggered immediately if it |