diff options
author | pennae <github@quasiparticle.net> | 2022-08-15 07:16:25 +0200 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-19 22:40:58 +0200 |
commit | 6039648c50c7c0858b5e506c6298773a98e0f066 (patch) | |
tree | 5421b3c36609e710c85b43d92dc3b830f6a1385b /nixos/modules/installer | |
parent | 7e7d68a250f75678451cd44f8c3d585bf750461e (diff) |
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/installer')
-rw-r--r-- | nixos/modules/installer/sd-card/sd-image.nix | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/nixos/modules/installer/sd-card/sd-image.nix b/nixos/modules/installer/sd-card/sd-image.nix index c0335ea487592..e192312649e2c 100644 --- a/nixos/modules/installer/sd-card/sd-image.nix +++ b/nixos/modules/installer/sd-card/sd-image.nix @@ -35,14 +35,14 @@ in options.sdImage = { imageName = mkOption { default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img"; - description = '' + description = lib.mdDoc '' Name of the generated image file. ''; }; imageBaseName = mkOption { default = "nixos-sd-image"; - description = '' + description = lib.mdDoc '' Prefix of the name of the generated image file. ''; }; @@ -50,7 +50,7 @@ in storePaths = mkOption { type = with types; listOf package; example = literalExpression "[ pkgs.stdenv ]"; - description = '' + description = lib.mdDoc '' Derivations to be included in the Nix store in the generated SD image. ''; }; @@ -74,7 +74,7 @@ in firmwarePartitionID = mkOption { type = types.str; default = "0x2178694e"; - description = '' + description = lib.mdDoc '' Volume ID for the /boot/firmware partition on the SD card. This value must be a 32-bit hexadecimal number. ''; @@ -83,7 +83,7 @@ in firmwarePartitionName = mkOption { type = types.str; default = "FIRMWARE"; - description = '' + description = lib.mdDoc '' Name of the filesystem which holds the boot firmware. ''; }; @@ -92,7 +92,7 @@ in type = types.nullOr types.str; default = null; example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7"; - description = '' + description = lib.mdDoc '' UUID for the filesystem on the main NixOS partition on the SD card. ''; }; @@ -101,14 +101,14 @@ in type = types.int; # As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB default = 30; - description = '' + description = lib.mdDoc '' Size of the /boot/firmware partition, in megabytes. ''; }; populateFirmwareCommands = mkOption { example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''"; - description = '' + description = lib.mdDoc '' Shell commands to populate the ./firmware directory. All files in that directory are copied to the /boot/firmware partition on the SD image. @@ -117,7 +117,7 @@ in populateRootCommands = mkOption { example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''"; - description = '' + description = lib.mdDoc '' Shell commands to populate the ./files directory. All files in that directory are copied to the root (/) partition on the SD image. Use this to @@ -128,7 +128,7 @@ in postBuildCommands = mkOption { example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''"; default = ""; - description = '' + description = lib.mdDoc '' Shell commands to run after the image is built. Can be used for boards requiring to dd u-boot SPL before actual partitions. ''; @@ -137,16 +137,16 @@ in compressImage = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the SD image should be compressed using - <command>zstd</command>. + {command}`zstd`. ''; }; expandOnBoot = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to configure the sd image to expand it's partition on boot. ''; }; |