colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/installer: invariant option docs MD conversions

Browse Source
This commit is contained in:
pennae 2022-07-20 12:32:04 +02:00
parent 77d56dfc22
commit 4ba72f8615
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
nixos/modules/installer/tools/tools.nix
View File

@ -74,15 +74,15 @@ in
configuration = mkOption {
internal = true;
type = types.str;
description = ''
The NixOS module that <literal>nixos-generate-config</literal>
saves to <literal>/etc/nixos/configuration.nix</literal>.
description = lib.mdDoc ''
The NixOS module that `nixos-generate-config`
saves to `/etc/nixos/configuration.nix`.
This is an internal option. No backward compatibility is guaranteed.
Use at your own risk!
Note that this string gets spliced into a Perl script. The perl
variable <literal>$bootLoaderConfig</literal> can be used to
variable `$bootLoaderConfig` can be used to
splice in the boot loader configuration.
'';
};
@ -91,15 +91,15 @@ in
internal = true;
type = types.listOf types.lines;
default = [];
description = ''
Text to preseed the desktop configuration that <literal>nixos-generate-config</literal>
saves to <literal>/etc/nixos/configuration.nix</literal>.
description = lib.mdDoc ''
Text to preseed the desktop configuration that `nixos-generate-config`
saves to `/etc/nixos/configuration.nix`.
This is an internal option. No backward compatibility is guaranteed.
Use at your own risk!
Note that this string gets spliced into a Perl script. The perl
variable <literal>$bootLoaderConfig</literal> can be used to
variable `$bootLoaderConfig` can be used to
splice in the boot loader configuration.
'';
};
@ -109,7 +109,7 @@ in
internal = true;
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Disable nixos-rebuild, nixos-generate-config, nixos-installer
and other NixOS tools. This is useful to shrink embedded,
read-only systems which are not expected to be rebuild or