diff options
author | Cole Helbling <cole.e.helbling@outlook.com> | 2022-12-01 16:29:18 -0800 |
---|---|---|
committer | Cole Helbling <cole.e.helbling@outlook.com> | 2022-12-08 13:50:05 -0800 |
commit | 97f657c742a60ff272881528268b1af7b10b6938 (patch) | |
tree | 713acdaddbcf8262a113dd8f8ce5f4814231a5f9 /nixos/modules/system | |
parent | cc63293b50cbc33c3e0519690fbaaec1b2434289 (diff) |
nixos/activation/bootspec: DocBook -> Markdown, add description for extensions field
Diffstat (limited to 'nixos/modules/system')
-rw-r--r-- | nixos/modules/system/activation/bootspec.nix | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/nixos/modules/system/activation/bootspec.nix b/nixos/modules/system/activation/bootspec.nix index 2d4f7158dd46e..cf74244b43b4a 100644 --- a/nixos/modules/system/activation/bootspec.nix +++ b/nixos/modules/system/activation/bootspec.nix @@ -64,11 +64,20 @@ let in { options.boot.bootspec = { - enable = lib.mkEnableOption "Enable generation of RFC-0125 bootspec in $system/bootspec, e.g. /run/current-system/bootspec"; + enable = lib.mkEnableOption (lib.mdDoc "Enable generation of RFC-0125 bootspec in $system/bootspec, e.g. /run/current-system/bootspec"); + extensions = lib.mkOption { type = lib.types.attrs; - default = {}; + default = { }; + description = lib.mdDoc '' + User-defined data that extends the bootspec document. + + To reduce incompatibility and prevent names from clashing + between applications, it is **highly recommended** to use a + unique namespace for your extensions. + ''; }; + # This will be run as a part of the `systemBuilder` in ./top-level.nix. This # means `$out` points to the output of `config.system.build.toplevel` and can # be used for a variety of things (though, for now, it's only used to report @@ -77,10 +86,12 @@ in internal = true; default = schemas.v1.generator; }; + validator = lib.mkOption { internal = true; default = schemas.v1.validator; }; + filename = lib.mkOption { internal = true; default = schemas.v1.filename; |