nixos/activation: document the arguments that are passed to the pre-switch-check script

r-vdp 713607ab 6b62fda0

Changed files
+3
nixos
modules
system
+3
nixos/modules/system/activation/pre-switch-check.nix
···
A set of shell script fragments that are executed before the switch to a
new NixOS system configuration. A failure in any of these fragments will
cause the switch to fail and exit early.
'';
type = lib.types.attrsOf lib.types.str;
···
A set of shell script fragments that are executed before the switch to a
new NixOS system configuration. A failure in any of these fragments will
cause the switch to fail and exit early.
+
The scripts receive the new configuration path and the action verb passed
+
to switch-to-configuration, as the first and second positional arguments
+
(meaning that you can access them using `$1` and `$2`, respectively).
'';
type = lib.types.attrsOf lib.types.str;