diff options
author | stuebinm <stuebinm@disroot.org> | 2024-04-13 14:54:15 +0200 |
---|---|---|
committer | Jonathan Ringer <jonringer@users.noreply.github.com> | 2024-04-13 10:07:35 -0700 |
commit | 6afb255d976f85f3359e4929abd6f5149c323a02 (patch) | |
tree | ced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/installer | |
parent | 1dd996e59a5e67694b7a252aacba71a88d51b41e (diff) |
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix two mentions of the mdDoc function remain in nixos/, both of which are inside of comments. Since lib.mdDoc is already defined as just id, this commit is a no-op as far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/installer')
-rw-r--r-- | nixos/modules/installer/cd-dvd/iso-image.nix | 38 | ||||
-rw-r--r-- | nixos/modules/installer/netboot/netboot.nix | 4 | ||||
-rw-r--r-- | nixos/modules/installer/sd-card/sd-image.nix | 26 | ||||
-rw-r--r-- | nixos/modules/installer/tools/tools.nix | 6 |
4 files changed, 37 insertions, 37 deletions
diff --git a/nixos/modules/installer/cd-dvd/iso-image.nix b/nixos/modules/installer/cd-dvd/iso-image.nix index f5b6af3a6b7ff..06949bda1cb2b 100644 --- a/nixos/modules/installer/cd-dvd/iso-image.nix +++ b/nixos/modules/installer/cd-dvd/iso-image.nix @@ -483,7 +483,7 @@ in isoImage.isoName = mkOption { default = "${config.isoImage.isoBaseName}.iso"; type = lib.types.str; - description = lib.mdDoc '' + description = '' Name of the generated ISO image file. ''; }; @@ -491,7 +491,7 @@ in isoImage.isoBaseName = mkOption { default = config.system.nixos.distroId; type = lib.types.str; - description = lib.mdDoc '' + description = '' Prefix of the name of the generated ISO image file. ''; }; @@ -499,7 +499,7 @@ in isoImage.compressImage = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Whether the ISO image should be compressed using {command}`zstd`. ''; @@ -513,7 +513,7 @@ in + lib.optionalString (isPower && is32bit && isBigEndian) "-Xbcj powerpc" + lib.optionalString (isSparc) "-Xbcj sparc"; type = lib.types.nullOr lib.types.str; - description = lib.mdDoc '' + description = '' Compression settings to use for the squashfs nix store. `null` disables compression. ''; @@ -523,7 +523,7 @@ in isoImage.edition = mkOption { default = ""; type = lib.types.str; - description = lib.mdDoc '' + description = '' Specifies which edition string to use in the volume ID of the generated ISO image. ''; @@ -533,7 +533,7 @@ in # nixos-$EDITION-$RELEASE-$ARCH default = "nixos${optionalString (config.isoImage.edition != "") "-${config.isoImage.edition}"}-${config.system.nixos.release}-${pkgs.stdenv.hostPlatform.uname.processor}"; type = lib.types.str; - description = lib.mdDoc '' + description = '' Specifies the label or volume ID of the generated ISO image. Note that the label is used by stage 1 of the boot process to mount the CD, so it should be reasonably distinctive. @@ -547,7 +547,7 @@ in } ] ''; - description = lib.mdDoc '' + description = '' This option lists files to be copied to fixed locations in the generated ISO image. ''; @@ -555,7 +555,7 @@ in isoImage.storeContents = mkOption { example = literalExpression "[ pkgs.stdenv ]"; - description = lib.mdDoc '' + description = '' This option lists additional derivations to be included in the Nix store in the generated ISO image. ''; @@ -564,7 +564,7 @@ in isoImage.includeSystemBuildDependencies = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Set this option to include all the needed sources etc in the image. It significantly increases image size. Use that when you want to be able to keep all the sources needed to build your @@ -586,7 +586,7 @@ in e.g. i686 and x86_64. ''; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Whether the ISO image should be a BIOS-bootable disk. ''; }; @@ -594,7 +594,7 @@ in isoImage.makeEfiBootable = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Whether the ISO image should be an EFI-bootable volume. ''; }; @@ -602,7 +602,7 @@ in isoImage.makeUsbBootable = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Whether the ISO image should be bootable from CD as well as USB. ''; }; @@ -612,7 +612,7 @@ in url = "https://raw.githubusercontent.com/NixOS/nixos-artwork/a9e05d7deb38a8e005a2b52575a3f59a63a4dba0/bootloader/efi-background.png"; sha256 = "18lfwmp8yq923322nlb9gxrh5qikj1wsk6g5qvdh31c4h5b1538x"; }; - description = lib.mdDoc '' + description = '' The splash image to use in the EFI bootloader. ''; }; @@ -622,7 +622,7 @@ in url = "https://raw.githubusercontent.com/NixOS/nixos-artwork/a9e05d7deb38a8e005a2b52575a3f59a63a4dba0/bootloader/isolinux/bios-boot.png"; sha256 = "1wp822zrhbg4fgfbwkr7cbkr4labx477209agzc0hr6k62fr6rxd"; }; - description = lib.mdDoc '' + description = '' The splash image to use in the legacy-boot bootloader. ''; }; @@ -630,7 +630,7 @@ in isoImage.grubTheme = mkOption { default = pkgs.nixos-grub2-theme; type = types.nullOr (types.either types.path types.package); - description = lib.mdDoc '' + description = '' The grub2 theme used for UEFI boot. ''; }; @@ -661,7 +661,7 @@ in MENU COLOR SEL 7;37;40 #FFFFFFFF #FF5277C3 std ''; type = types.str; - description = lib.mdDoc '' + description = '' The syslinux theme used for BIOS boot. ''; }; @@ -670,7 +670,7 @@ in default = ""; type = types.str; example = "Install "; - description = lib.mdDoc '' + description = '' The string to prepend before the menu label for the NixOS system. This will be directly prepended (without whitespace) to the NixOS version string, like for example if it is set to `XXX`: @@ -683,7 +683,7 @@ in default = " Installer"; type = types.str; example = " Live System"; - description = lib.mdDoc '' + description = '' The string to append after the menu label for the NixOS system. This will be directly appended (without whitespace) to the NixOS version string, like for example if it is set to `XXX`: @@ -696,7 +696,7 @@ in default = false; type = types.bool; example = true; - description = lib.mdDoc '' + description = '' Whether to use text mode instead of graphical grub. A value of `true` means graphical mode is not tried to be used. diff --git a/nixos/modules/installer/netboot/netboot.nix b/nixos/modules/installer/netboot/netboot.nix index 028a2d74041e6..c88a53393d13f 100644 --- a/nixos/modules/installer/netboot/netboot.nix +++ b/nixos/modules/installer/netboot/netboot.nix @@ -15,7 +15,7 @@ with lib; + lib.optionalString isAarch "-Xbcj arm" + lib.optionalString (isPower && is32bit && isBigEndian) "-Xbcj powerpc" + lib.optionalString (isSparc) "-Xbcj sparc"; - description = lib.mdDoc '' + description = '' Compression settings to use for the squashfs nix store. ''; example = "zstd -Xcompression-level 6"; @@ -24,7 +24,7 @@ with lib; netboot.storeContents = mkOption { example = literalExpression "[ pkgs.stdenv ]"; - description = lib.mdDoc '' + description = '' This option lists additional derivations to be included in the Nix store in the generated netboot image. ''; diff --git a/nixos/modules/installer/sd-card/sd-image.nix b/nixos/modules/installer/sd-card/sd-image.nix index ad9b803b1d1e4..1c79bf4ac3ef7 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 = lib.mdDoc '' + description = '' Name of the generated image file. ''; }; imageBaseName = mkOption { default = "nixos-sd-image"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Derivations to be included in the Nix store in the generated SD image. ''; }; @@ -58,7 +58,7 @@ in firmwarePartitionOffset = mkOption { type = types.int; default = 8; - description = lib.mdDoc '' + description = '' Gap in front of the /boot/firmware partition, in mebibytes (1024×1024 bytes). Can be increased to make more space for boards requiring to dd u-boot @@ -74,7 +74,7 @@ in firmwarePartitionID = mkOption { type = types.str; default = "0x2178694e"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Size of the /boot/firmware partition, in megabytes. ''; }; populateFirmwareCommands = mkOption { example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Shell commands to run after the image is built. Can be used for boards requiring to dd u-boot SPL before actual partitions. ''; @@ -137,7 +137,7 @@ in compressImage = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether the SD image should be compressed using {command}`zstd`. ''; @@ -146,7 +146,7 @@ in expandOnBoot = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to configure the sd image to expand it's partition on boot. ''; }; diff --git a/nixos/modules/installer/tools/tools.nix b/nixos/modules/installer/tools/tools.nix index 3ef9a8cdca202..e7f9990e9632e 100644 --- a/nixos/modules/installer/tools/tools.nix +++ b/nixos/modules/installer/tools/tools.nix @@ -87,7 +87,7 @@ in configuration = mkOption { internal = true; type = types.str; - description = lib.mdDoc '' + description = '' The NixOS module that `nixos-generate-config` saves to `/etc/nixos/configuration.nix`. @@ -104,7 +104,7 @@ in internal = true; type = types.listOf types.lines; default = []; - description = lib.mdDoc '' + description = '' Text to preseed the desktop configuration that `nixos-generate-config` saves to `/etc/nixos/configuration.nix`. @@ -122,7 +122,7 @@ in internal = true; type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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 |