mirror of
https://github.com/LnL7/nix-darwin.git
synced 2024-12-14 11:57:34 +00:00
861af0fc94
Stricter launchd -> StartCalendarInterval type:
- Verify that the integers passed to `Minute`, `Hour`, etc. are within
range.
- When provided, the value for StartCalendarInterval must be a non-empty
list of calendar intervals and must not contain duplicates entries
(throw an error otherwise).
- For increased flexibility and backwards-compatibility, allow an
attrset to be passed as well (which will be type-checked and is
functionally equivalent to passing a singleton list). Allowing an
attrset or list is precisely in-line with what `launchd.plist(5)`
accepts for StartCalendarInterval.
Migrate `nix.gc.interval` and `nix.optimise.interval` over to use this
new type, and update their defaults to run weekly instead of daily.
Create `modules/launchd/types.nix` file for easier/modular use of
launchd types needed in multiple files.
Documentation:
- Update and improve wording/documentation of launchd's
`StartCalendarInterval`.
- Improve wording/documentation of `nix.gc.interval` and
`nix.optimise.interval` ("time interval" can be misleading as it's
actually a "calendar interval"; e.g. `{ Hour = 3; Minute = 15;}`
runs daily, not every 3.25 hours).
76 lines
2.1 KiB
Nix
76 lines
2.1 KiB
Nix
# Based off: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/nix-gc.nix
|
|
# When making changes please try to keep it in sync.
|
|
{ config, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.nix.gc;
|
|
launchdTypes = import ../../launchd/types.nix { inherit config lib; };
|
|
in
|
|
|
|
{
|
|
imports = [
|
|
(mkRemovedOptionModule [ "nix" "gc" "dates" ] "Use `nix.gc.interval` instead.")
|
|
(mkRemovedOptionModule [ "nix" "gc" "randomizedDelaySec" ] "No `nix-darwin` equivalent to this NixOS option.")
|
|
(mkRemovedOptionModule [ "nix" "gc" "persistent" ] "No `nix-darwin` equivalent to this NixOS option.")
|
|
];
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
nix.gc = {
|
|
|
|
automatic = mkOption {
|
|
default = false;
|
|
type = types.bool;
|
|
description = "Automatically run the garbage collector at a specific time.";
|
|
};
|
|
|
|
# Not in NixOS module
|
|
user = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = "User that runs the garbage collector.";
|
|
};
|
|
|
|
interval = mkOption {
|
|
type = launchdTypes.StartCalendarInterval;
|
|
default = [{ Weekday = 7; Hour = 3; Minute = 15; }];
|
|
description = ''
|
|
The calendar interval at which the garbage collector will run.
|
|
See the {option}`serviceConfig.StartCalendarInterval` option of
|
|
the {option}`launchd` module for more info.
|
|
'';
|
|
};
|
|
|
|
options = mkOption {
|
|
default = "";
|
|
example = "--max-freed $((64 * 1024**3))";
|
|
type = types.str;
|
|
description = ''
|
|
Options given to {file}`nix-collect-garbage` when the
|
|
garbage collector is run automatically.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.automatic {
|
|
|
|
launchd.daemons.nix-gc = {
|
|
command = "${config.nix.package}/bin/nix-collect-garbage ${cfg.options}";
|
|
environment.NIX_REMOTE = optionalString config.nix.useDaemon "daemon";
|
|
serviceConfig.RunAtLoad = false;
|
|
serviceConfig.StartCalendarInterval = cfg.interval;
|
|
serviceConfig.UserName = cfg.user;
|
|
};
|
|
|
|
};
|
|
}
|