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

This commit is contained in:
r-vdp 2025-01-28 12:00:10 +01:00
parent 6b62fda029
commit 713607abea
No known key found for this signature in database

View File

@ -44,6 +44,9 @@ in
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;