mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-19 07:59:24 +03:00

After final improvements to the official formatter implementation, this commit now performs the first treewide reformat of Nix files using it. This is part of the implementation of RFC 166. Only "inactive" files are reformatted, meaning only files that aren't being touched by any PR with activity in the past 2 months. This is to avoid conflicts for PRs that might soon be merged. Later we can do a full treewide reformat to get the rest, which should not cause as many conflicts. A CI check has already been running for some time to ensure that new and already-formatted files are formatted, so the files being reformatted here should also stay formatted. This commit was automatically created and can be verified using nix-builda08b3a4d19
.tar.gz \ --argstr baseRevb32a094368
result/bin/apply-formatting $NIXPKGS_PATH
101 lines
2.8 KiB
Nix
101 lines
2.8 KiB
Nix
{ config, lib, ... }:
|
|
|
|
let
|
|
cfg = config.nix.gc;
|
|
in
|
|
|
|
{
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
nix.gc = {
|
|
|
|
automatic = lib.mkOption {
|
|
default = false;
|
|
type = lib.types.bool;
|
|
description = "Automatically run the garbage collector at a specific time.";
|
|
};
|
|
|
|
dates = lib.mkOption {
|
|
type = lib.types.singleLineStr;
|
|
default = "03:15";
|
|
example = "weekly";
|
|
description = ''
|
|
How often or when garbage collection is performed. For most desktop and server systems
|
|
a sufficient garbage collection is once a week.
|
|
|
|
This value must be a calendar event in the format specified by
|
|
{manpage}`systemd.time(7)`.
|
|
'';
|
|
};
|
|
|
|
randomizedDelaySec = lib.mkOption {
|
|
default = "0";
|
|
type = lib.types.singleLineStr;
|
|
example = "45min";
|
|
description = ''
|
|
Add a randomized delay before each garbage collection.
|
|
The delay will be chosen between zero and this value.
|
|
This value must be a time span in the format specified by
|
|
{manpage}`systemd.time(7)`
|
|
'';
|
|
};
|
|
|
|
persistent = lib.mkOption {
|
|
default = true;
|
|
type = lib.types.bool;
|
|
example = false;
|
|
description = ''
|
|
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
|
|
would have been triggered at least once during the time when
|
|
the timer was inactive. Such triggering is nonetheless
|
|
subject to the delay imposed by RandomizedDelaySec=. This is
|
|
useful to catch up on missed runs of the service when the
|
|
system was powered down.
|
|
'';
|
|
};
|
|
|
|
options = lib.mkOption {
|
|
default = "";
|
|
example = "--max-freed $((64 * 1024**3))";
|
|
type = lib.types.singleLineStr;
|
|
description = ''
|
|
Options given to [`nix-collect-garbage`](https://nixos.org/manual/nix/stable/command-ref/nix-collect-garbage) when the garbage collector is run automatically.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = {
|
|
assertions = [
|
|
{
|
|
assertion = cfg.automatic -> config.nix.enable;
|
|
message = ''nix.gc.automatic requires nix.enable'';
|
|
}
|
|
];
|
|
|
|
systemd.services.nix-gc = lib.mkIf config.nix.enable {
|
|
description = "Nix Garbage Collector";
|
|
script = "exec ${config.nix.package.out}/bin/nix-collect-garbage ${cfg.options}";
|
|
serviceConfig.Type = "oneshot";
|
|
startAt = lib.optional cfg.automatic cfg.dates;
|
|
};
|
|
|
|
systemd.timers.nix-gc = lib.mkIf cfg.automatic {
|
|
timerConfig = {
|
|
RandomizedDelaySec = cfg.randomizedDelaySec;
|
|
Persistent = cfg.persistent;
|
|
};
|
|
};
|
|
|
|
};
|
|
|
|
}
|