nixos: Document system.build.toplevel

This commit is contained in:
Robert Hensing 2022-01-20 15:05:45 +01:00
parent ba3e91ed43
commit 2aa7c25808

View File

@ -135,6 +135,16 @@ let
pkgs.replaceDependency { inherit oldDependency newDependency drv; }
) baseSystemAssertWarn config.system.replaceRuntimeDependencies;
/* Workaround until https://github.com/NixOS/nixpkgs/pull/156533
Call can be replaced by argument when that's merged.
*/
tmpFixupSubmoduleBoundary = subopts:
lib.mkOption {
type = lib.types.submoduleWith {
modules = [ { options = subopts; } ];
};
};
in
{
@ -216,6 +226,19 @@ in
'';
};
system.build = tmpFixupSubmoduleBoundary {
toplevel = mkOption {
type = types.package;
readOnly = true;
description = ''
This option contains the store path that typically represents a NixOS system.
You can read this path in a custom deployment tool for example.
'';
};
};
system.copySystemConfiguration = mkOption {
type = types.bool;
default = false;