diff options
Diffstat (limited to 'nixos/modules/system')
57 files changed, 504 insertions, 510 deletions
diff --git a/nixos/modules/system/activation/activatable-system.nix b/nixos/modules/system/activation/activatable-system.nix index 3d941596747bf..e442fce7541b9 100644 --- a/nixos/modules/system/activation/activatable-system.nix +++ b/nixos/modules/system/activation/activatable-system.nix @@ -25,7 +25,7 @@ in ''; }; system.activatableSystemBuilderCommands = options.system.systemBuilderCommands // { - description = lib.mdDoc '' + description = '' Like `system.systemBuilderCommands`, but only for the commands that are needed *both* when the system is activatable and when it isn't. diff --git a/nixos/modules/system/activation/activation-script.nix b/nixos/modules/system/activation/activation-script.nix index bc0b7266ce959..fc29aa3cb2f71 100644 --- a/nixos/modules/system/activation/activation-script.nix +++ b/nixos/modules/system/activation/activation-script.nix @@ -74,17 +74,17 @@ let { deps = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc "List of dependencies. The script will run after these."; + description = "List of dependencies. The script will run after these."; }; text = mkOption { type = types.lines; - description = lib.mdDoc "The content of the script."; + description = "The content of the script."; }; } // optionalAttrs withDry { supportsDryActivation = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether this activation script supports being dry-activated. These activation scripts will also be executed on dry-activate activations with the environment variable @@ -119,7 +119,7 @@ in } ''; - description = lib.mdDoc '' + description = '' A set of shell script fragments that are executed when a NixOS system configuration is activated. Examples are updating /etc, creating accounts, and so on. Since these are executed @@ -135,7 +135,7 @@ in }; system.dryActivationScript = mkOption { - description = lib.mdDoc "The shell script that is to be run when dry-activating a system."; + description = "The shell script that is to be run when dry-activating a system."; readOnly = true; internal = true; default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true; @@ -155,7 +155,7 @@ in } ''; - description = lib.mdDoc '' + description = '' A set of shell script fragments that are executed by a systemd user service when a NixOS system configuration is activated. Examples are rebuilding the .desktop file cache for showing applications in the menu. @@ -195,7 +195,7 @@ in example = literalExpression ''"''${pkgs.busybox}/bin/env"''; type = types.nullOr types.path; visible = false; - description = lib.mdDoc '' + description = '' The env(1) executable that is linked system-wide to `/usr/bin/env`. ''; @@ -207,7 +207,7 @@ in # go to `true` instead of `echo`, hiding the useless path # from the log. default = "echo 'Warning: do not know how to make this configuration bootable; please enable a boot loader.' 1>&2; true"; - description = lib.mdDoc '' + description = '' A program that writes a bootloader installation script to the path passed in the first command line argument. See `nixos/modules/system/activation/switch-to-configuration.pl`. diff --git a/nixos/modules/system/activation/bootspec.nix b/nixos/modules/system/activation/bootspec.nix index 2ed6964b2a6a6..3c2b91cce7016 100644 --- a/nixos/modules/system/activation/bootspec.nix +++ b/nixos/modules/system/activation/bootspec.nix @@ -77,19 +77,18 @@ let in { options.boot.bootspec = { - enable = lib.mkEnableOption (lib.mdDoc "the generation of RFC-0125 bootspec in $system/boot.json, e.g. /run/current-system/boot.json") + enable = lib.mkEnableOption "the generation of RFC-0125 bootspec in $system/boot.json, e.g. /run/current-system/boot.json" // { default = true; internal = true; }; - enableValidation = lib.mkEnableOption (lib.mdDoc ''the validation of bootspec documents for each build. + enableValidation = lib.mkEnableOption ''the validation of bootspec documents for each build. This will introduce Go in the build-time closure as we are relying on [Cuelang](https://cuelang.org/) for schema validation. Enable this option if you want to ascertain that your documents are correct - '' - ); + ''; extensions = lib.mkOption { # NOTE(RaitoBezarius): this is not enough to validate: extensions."osRelease" = drv; those are picked up by cue validation. type = lib.types.attrsOf lib.types.anything; # <namespace>: { ...namespace-specific fields } default = { }; - description = lib.mdDoc '' + description = '' User-defined data that extends the bootspec document. To reduce incompatibility and prevent names from clashing diff --git a/nixos/modules/system/activation/specialisation.nix b/nixos/modules/system/activation/specialisation.nix index 86603c8476419..fdab287802fa5 100644 --- a/nixos/modules/system/activation/specialisation.nix +++ b/nixos/modules/system/activation/specialisation.nix @@ -27,7 +27,7 @@ in specialisation = mkOption { default = { }; example = lib.literalExpression "{ fewJobsManyCores.configuration = { nix.settings = { core = 0; max-jobs = 1; }; }; }"; - description = lib.mdDoc '' + description = '' Additional configurations to build. If `inheritParentConfig` is true, the system will be based on the overall system configuration. @@ -51,12 +51,12 @@ in options.inheritParentConfig = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Include the entire system's configuration. Set to false to make a completely differently configured system."; + description = "Include the entire system's configuration. Set to false to make a completely differently configured system."; }; options.configuration = mkOption { default = { }; - description = lib.mdDoc '' + description = '' Arbitrary NixOS configuration. Anything you can add to a normal NixOS configuration, you can add diff --git a/nixos/modules/system/activation/switchable-system.nix b/nixos/modules/system/activation/switchable-system.nix index 00bc18e48d1fb..d5bd8cc1dc115 100644 --- a/nixos/modules/system/activation/switchable-system.nix +++ b/nixos/modules/system/activation/switchable-system.nix @@ -12,7 +12,7 @@ in system.switch.enable = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to include the capability to switch configurations. Disabling this makes the system unable to be reconfigured via `nixos-rebuild`. diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix index 1f9ad570db7d8..4cf3012646fa3 100644 --- a/nixos/modules/system/activation/top-level.nix +++ b/nixos/modules/system/activation/top-level.nix @@ -93,7 +93,7 @@ in system.boot.loader.id = mkOption { internal = true; default = ""; - description = lib.mdDoc '' + description = '' Id string of the used bootloader. ''; }; @@ -103,7 +103,7 @@ in default = pkgs.stdenv.hostPlatform.linux-kernel.target; defaultText = literalExpression "pkgs.stdenv.hostPlatform.linux-kernel.target"; type = types.str; - description = lib.mdDoc '' + description = '' Name of the kernel file to be passed to the bootloader. ''; }; @@ -112,7 +112,7 @@ in internal = true; default = "initrd"; type = types.str; - description = lib.mdDoc '' + description = '' Name of the initrd file to be passed to the bootloader. ''; }; @@ -121,7 +121,7 @@ in toplevel = mkOption { type = types.package; readOnly = true; - description = lib.mdDoc '' + 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. @@ -133,7 +133,7 @@ in system.copySystemConfiguration = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' If enabled, copies the NixOS configuration file (usually {file}`/etc/nixos/configuration.nix`) and links it from the resulting system @@ -155,7 +155,7 @@ in type = types.attrsOf types.unspecified; internal = true; default = {}; - description = lib.mdDoc '' + description = '' `lib.mkDerivation` attributes that will be passed to the top level system builder. ''; }; @@ -164,7 +164,7 @@ in default = ""; example = "-dev$"; type = types.str; - description = lib.mdDoc '' + description = '' A POSIX Extended Regular Expression that matches store paths that should not appear in the system closure, with the exception of {option}`system.extraDependencies`, which is not checked. ''; @@ -174,7 +174,7 @@ in type = types.lines; internal = true; default = ""; - description = lib.mdDoc '' + description = '' This code will be added to the builder creating the system store path. ''; }; @@ -182,7 +182,7 @@ in system.extraDependencies = mkOption { type = types.listOf types.pathInStore; default = []; - description = lib.mdDoc '' + description = '' A list of paths that should be included in the system closure but generally not visible to users. @@ -195,7 +195,7 @@ in system.checks = mkOption { type = types.listOf types.package; default = []; - description = lib.mdDoc '' + description = '' Packages that are added as dependencies of the system's build, usually for the purpose of validating some part of the configuration. @@ -211,12 +211,12 @@ in { ... }: { options.original = mkOption { type = types.package; - description = lib.mdDoc "The original package to override."; + description = "The original package to override."; }; options.replacement = mkOption { type = types.package; - description = lib.mdDoc "The replacement package."; + description = "The replacement package."; }; }) ); @@ -224,7 +224,7 @@ in oldDependency = original; newDependency = replacement; }); - description = lib.mdDoc '' + description = '' List of packages to override without doing a full rebuild. The original derivation and replacement derivation must have the same name length, and ideally should have close-to-identical directory layout. @@ -242,7 +242,7 @@ in then "unnamed" else config.networking.hostName; ''; - description = lib.mdDoc '' + description = '' The name of the system used in the {option}`system.build.toplevel` derivation. That derivation has the following name: @@ -253,7 +253,7 @@ in system.includeBuildDependencies = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to include the build closure of the whole system in its runtime closure. This can be useful for making changes fully offline, as it includes all sources, patches, and diff --git a/nixos/modules/system/boot/binfmt.nix b/nixos/modules/system/boot/binfmt.nix index 2242c9da62d08..3605ce56910ed 100644 --- a/nixos/modules/system/boot/binfmt.nix +++ b/nixos/modules/system/boot/binfmt.nix @@ -155,7 +155,7 @@ in { registrations = mkOption { default = {}; - description = lib.mdDoc '' + description = '' Extra binary formats to register with the kernel. See https://www.kernel.org/doc/html/latest/admin-guide/binfmt-misc.html for more details. ''; @@ -164,30 +164,29 @@ in { options = { recognitionType = mkOption { default = "magic"; - description = lib.mdDoc "Whether to recognize executables by magic number or extension."; + description = "Whether to recognize executables by magic number or extension."; type = types.enum [ "magic" "extension" ]; }; offset = mkOption { default = null; - description = lib.mdDoc "The byte offset of the magic number used for recognition."; + description = "The byte offset of the magic number used for recognition."; type = types.nullOr types.int; }; magicOrExtension = mkOption { - description = lib.mdDoc "The magic number or extension to match on."; + description = "The magic number or extension to match on."; type = types.str; }; mask = mkOption { default = null; - description = - lib.mdDoc "A mask to be ANDed with the byte sequence of the file before matching"; + description = "A mask to be ANDed with the byte sequence of the file before matching"; type = types.nullOr types.str; }; interpreter = mkOption { - description = lib.mdDoc '' + description = '' The interpreter to invoke to run the program. Note that the actual registration will point to @@ -199,7 +198,7 @@ in { preserveArgvZero = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to pass the original argv[0] to the interpreter. See the description of the 'P' flag in the kernel docs @@ -210,7 +209,7 @@ in { openBinary = mkOption { default = config.matchCredentials; - description = lib.mdDoc '' + description = '' Whether to pass the binary to the interpreter as an open file descriptor, instead of a path. ''; @@ -219,7 +218,7 @@ in { matchCredentials = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to launch with the credentials and security token of the binary, not the interpreter (e.g. setuid bit). @@ -234,7 +233,7 @@ in { fixBinary = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to open the interpreter file as soon as the registration is loaded, rather than waiting for a relevant file to be invoked. @@ -247,7 +246,7 @@ in { wrapInterpreterInShell = mkOption { default = true; - description = lib.mdDoc '' + description = '' Whether to wrap the interpreter in a shell script. This allows a shell command to be set as the interpreter. @@ -258,7 +257,7 @@ in { interpreterSandboxPath = mkOption { internal = true; default = null; - description = lib.mdDoc '' + description = '' Path of the interpreter to expose in the build sandbox. ''; type = types.nullOr types.path; @@ -270,7 +269,7 @@ in { emulatedSystems = mkOption { default = []; example = [ "wasm32-wasi" "x86_64-windows" "aarch64-linux" ]; - description = lib.mdDoc '' + description = '' List of systems to emulate. Will also configure Nix to support your new systems. Warning: the builder can execute all emulated systems within the same build, which introduces impurities in the case of cross compilation. diff --git a/nixos/modules/system/boot/clevis.nix b/nixos/modules/system/boot/clevis.nix index 0c72590f93851..d9390f5bc15f8 100644 --- a/nixos/modules/system/boot/clevis.nix +++ b/nixos/modules/system/boot/clevis.nix @@ -12,14 +12,14 @@ in meta.doc = ./clevis.md; options = { - boot.initrd.clevis.enable = mkEnableOption (lib.mdDoc "Clevis in initrd"); + boot.initrd.clevis.enable = mkEnableOption "Clevis in initrd"; boot.initrd.clevis.package = mkOption { type = types.package; default = pkgs.clevis; defaultText = "pkgs.clevis"; - description = lib.mdDoc "Clevis package"; + description = "Clevis package"; }; boot.initrd.clevis.devices = mkOption { @@ -27,7 +27,7 @@ in default = { }; type = types.attrsOf (types.submodule ({ options.secretFile = mkOption { - description = lib.mdDoc "Clevis JWE file used to decrypt the device at boot, in concert with the chosen pin (one of TPM2, Tang server, or SSS)."; + description = "Clevis JWE file used to decrypt the device at boot, in concert with the chosen pin (one of TPM2, Tang server, or SSS)."; type = types.path; }; })); diff --git a/nixos/modules/system/boot/emergency-mode.nix b/nixos/modules/system/boot/emergency-mode.nix index a2163aa5ffb3d..717ab08f2534d 100644 --- a/nixos/modules/system/boot/emergency-mode.nix +++ b/nixos/modules/system/boot/emergency-mode.nix @@ -11,7 +11,7 @@ with lib; systemd.enableEmergencyMode = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable emergency mode, which is an {command}`sulogin` shell started on the console if mounting a filesystem fails. Since some machines (like EC2 diff --git a/nixos/modules/system/boot/grow-partition.nix b/nixos/modules/system/boot/grow-partition.nix index 8a0fc3a03dac4..4f8a2273a7ace 100644 --- a/nixos/modules/system/boot/grow-partition.nix +++ b/nixos/modules/system/boot/grow-partition.nix @@ -12,7 +12,7 @@ with lib; ]; options = { - boot.growPartition = mkEnableOption (lib.mdDoc "growing the root partition on boot"); + boot.growPartition = mkEnableOption "growing the root partition on boot"; }; config = mkIf config.boot.growPartition { diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix index 88ba43caf0030..6f63f16271246 100644 --- a/nixos/modules/system/boot/initrd-network.nix +++ b/nixos/modules/system/boot/initrd-network.nix @@ -50,7 +50,7 @@ in boot.initrd.network.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Add network connectivity support to initrd. The network may be configured using the `ip` kernel parameter, as described in [the kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt). @@ -69,7 +69,7 @@ in type = types.bool; default = !config.boot.initrd.systemd.enable; defaultText = "!config.boot.initrd.systemd.enable"; - description = lib.mdDoc '' + description = '' Whether to clear the configuration of the interfaces that were set up in the initrd right before stage 2 takes over. Stage 2 will do the regular network configuration based on the NixOS networking options. @@ -83,7 +83,7 @@ in default = config.networking.useDHCP && !config.boot.initrd.systemd.enable; defaultText = "networking.useDHCP"; type = types.bool; - description = lib.mdDoc '' + description = '' Enables the udhcpc service during stage 1 of the boot process. This defaults to {option}`networking.useDHCP`. Therefore, this useful if useDHCP is off but the initramfs should do dhcp. @@ -93,7 +93,7 @@ in boot.initrd.network.udhcpc.extraArgs = mkOption { default = []; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Additional command-line arguments passed verbatim to udhcpc if {option}`boot.initrd.network.enable` and {option}`boot.initrd.network.udhcpc.enable` are enabled. @@ -103,7 +103,7 @@ in boot.initrd.network.postCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed after stage 1 of the boot has initialised the network. ''; diff --git a/nixos/modules/system/boot/initrd-openvpn.nix b/nixos/modules/system/boot/initrd-openvpn.nix index 2530240628e42..602d80fa338a2 100644 --- a/nixos/modules/system/boot/initrd-openvpn.nix +++ b/nixos/modules/system/boot/initrd-openvpn.nix @@ -15,7 +15,7 @@ in boot.initrd.network.openvpn.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Starts an OpenVPN client during initrd boot. It can be used to e.g. remotely accessing the SSH service controlled by {option}`boot.initrd.network.ssh` or other network services @@ -25,7 +25,7 @@ in boot.initrd.network.openvpn.configuration = mkOption { type = types.path; # Same type as boot.initrd.secrets - description = lib.mdDoc '' + description = '' The configuration file for OpenVPN. ::: {.warning} diff --git a/nixos/modules/system/boot/initrd-ssh.nix b/nixos/modules/system/boot/initrd-ssh.nix index 43da2496d16c7..9ce5a85b4f073 100644 --- a/nixos/modules/system/boot/initrd-ssh.nix +++ b/nixos/modules/system/boot/initrd-ssh.nix @@ -18,7 +18,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Start SSH service during initrd boot. It can be used to debug failing boot on a remote server, enter pasphrase for an encrypted partition etc. Service is killed when stage-1 boot is finished. @@ -31,7 +31,7 @@ in port = mkOption { type = types.port; default = 22; - description = lib.mdDoc '' + description = '' Port on which SSH initrd service should listen. ''; }; @@ -40,7 +40,7 @@ in type = types.nullOr types.str; default = null; defaultText = ''"/bin/ash"''; - description = lib.mdDoc '' + description = '' Login shell of the remote user. Can be used to limit actions user can do. ''; }; @@ -52,7 +52,7 @@ in "/etc/secrets/initrd/ssh_host_rsa_key" "/etc/secrets/initrd/ssh_host_ed25519_key" ]; - description = lib.mdDoc '' + description = '' Specify SSH host keys to import into the initrd. To generate keys, use @@ -81,7 +81,7 @@ in ignoreEmptyHostKeys = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Allow leaving {option}`config.boot.initrd.network.ssh` empty, to deploy ssh host keys out of band. ''; @@ -91,7 +91,7 @@ in type = types.listOf types.str; default = config.users.users.root.openssh.authorizedKeys.keys; defaultText = literalExpression "config.users.users.root.openssh.authorizedKeys.keys"; - description = lib.mdDoc '' + description = '' Authorized keys for the root user on initrd. You can combine the `authorizedKeys` and `authorizedKeyFiles` options. ''; @@ -105,7 +105,7 @@ in type = types.listOf types.path; default = config.users.users.root.openssh.authorizedKeys.keyFiles; defaultText = literalExpression "config.users.users.root.openssh.authorizedKeys.keyFiles"; - description = lib.mdDoc '' + description = '' Authorized keys taken from files for the root user on initrd. You can combine the `authorizedKeyFiles` and `authorizedKeys` options. ''; @@ -114,7 +114,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc "Verbatim contents of {file}`sshd_config`."; + description = "Verbatim contents of {file}`sshd_config`."; }; }; diff --git a/nixos/modules/system/boot/kernel.nix b/nixos/modules/system/boot/kernel.nix index 950cff386d025..4854119b25382 100644 --- a/nixos/modules/system/boot/kernel.nix +++ b/nixos/modules/system/boot/kernel.nix @@ -20,7 +20,7 @@ in ###### interface options = { - boot.kernel.enable = mkEnableOption (lib.mdDoc "the Linux kernel. This is useful for systemd-like containers which do not require a kernel") // { + boot.kernel.enable = mkEnableOption "the Linux kernel. This is useful for systemd-like containers which do not require a kernel" // { default = true; }; @@ -28,7 +28,7 @@ in default = {}; example = literalExpression "{ debug = true; }"; internal = true; - description = lib.mdDoc '' + description = '' This option allows to enable or disable certain kernel features. It's not API, because it's about kernel feature sets, that make sense for specific use cases. Mostly along with programs, @@ -51,7 +51,7 @@ in # - some of it might not even evaluate correctly. defaultText = literalExpression "pkgs.linuxPackages"; example = literalExpression "pkgs.linuxKernel.packages.linux_5_10"; - description = lib.mdDoc '' + description = '' This option allows you to override the Linux kernel used by NixOS. Since things like external kernel module packages are tied to the kernel you're using, it also overrides those. @@ -90,7 +90,7 @@ in } ] ''; - description = lib.mdDoc '' + description = '' A list of additional patches to apply to the kernel. Every item should be an attribute set with the following attributes: @@ -127,7 +127,7 @@ in type = types.str; default = ""; example = "my secret seed"; - description = lib.mdDoc '' + description = '' Provides a custom seed for the {var}`RANDSTRUCT` security option of the Linux kernel. Note that {var}`RANDSTRUCT` is only enabled in NixOS hardened kernels. Using a custom seed requires @@ -142,13 +142,13 @@ in description = "string, with spaces inside double quotes"; }); default = [ ]; - description = lib.mdDoc "Parameters added to the kernel command line."; + description = "Parameters added to the kernel command line."; }; boot.consoleLogLevel = mkOption { type = types.int; default = 4; - description = lib.mdDoc '' + description = '' The kernel console `loglevel`. All Kernel Messages with a log level smaller than this setting will be printed to the console. ''; @@ -157,7 +157,7 @@ in boot.vesa = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' (Deprecated) This option, if set, activates the VESA 800x600 video mode on boot and disables kernel modesetting. It is equivalent to specifying `[ "vga=0x317" "nomodeset" ]` in the @@ -171,13 +171,13 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ config.boot.kernelPackages.nvidia_x11 ]"; - description = lib.mdDoc "A list of additional packages supplying kernel modules."; + description = "A list of additional packages supplying kernel modules."; }; boot.kernelModules = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' The set of kernel modules to be loaded in the second stage of the boot process. Note that modules that are needed to mount the root file system should be added to @@ -190,7 +190,7 @@ in type = types.listOf types.str; default = []; example = [ "sata_nv" "ext3" ]; - description = lib.mdDoc '' + description = '' The set of kernel modules in the initial ramdisk used during the boot process. This set must include all modules necessary for mounting the root device. That is, it should include modules @@ -210,13 +210,13 @@ in boot.initrd.kernelModules = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc "List of modules that are always loaded by the initrd."; + description = "List of modules that are always loaded by the initrd."; }; boot.initrd.includeDefaultModules = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' This option, if set, adds a collection of default kernel modules to {option}`boot.initrd.availableKernelModules` and {option}`boot.initrd.kernelModules`. @@ -227,7 +227,7 @@ in type = types.listOf types.path; internal = true; default = []; - description = lib.mdDoc '' + description = '' Tree of kernel modules. This includes the kernel, plus modules built outside of the kernel. Combine these into a single tree of symlinks because modprobe only supports one directory. @@ -249,7 +249,7 @@ in ''; internal = true; type = types.listOf types.attrs; - description = lib.mdDoc '' + description = '' This option allows modules to specify the kernel config options that must be set (or unset) for the module to work. Please use the lib.kernelConfig functions to build list elements. diff --git a/nixos/modules/system/boot/kernel_config.nix b/nixos/modules/system/boot/kernel_config.nix index e618070f0dc3e..a98ee2deda699 100644 --- a/nixos/modules/system/boot/kernel_config.nix +++ b/nixos/modules/system/boot/kernel_config.nix @@ -14,7 +14,7 @@ let default = null; internal = true; visible = true; - description = lib.mdDoc '' + description = '' Use this field for tristate kernel options expecting a "y" or "m" or "n". ''; }; @@ -25,7 +25,7 @@ let }; default = null; example = ''MMC_BLOCK_MINORS.freeform = "32";''; - description = lib.mdDoc '' + description = '' Freeform description of a kernel configuration item value. ''; }; @@ -33,7 +33,7 @@ let optional = mkOption { type = types.bool // { merge = mergeFalseByDefault; }; default = false; - description = lib.mdDoc '' + description = '' Whether option should generate a failure when unused. Upon merging values, mandatory wins over optional. ''; @@ -90,7 +90,7 @@ in USB? y DEBUG n ''; - description = lib.mdDoc '' + description = '' The result of converting the structured kernel configuration in settings to an intermediate string that can be parsed by generate-config.pl to answer the kernel `make defconfig`. @@ -104,7 +104,7 @@ in USB = option yes; MMC_BLOCK_MINORS = freeform "32"; }''; - description = lib.mdDoc '' + description = '' Structured kernel configuration. ''; }; diff --git a/nixos/modules/system/boot/loader/efi.nix b/nixos/modules/system/boot/loader/efi.nix index 2661f362249db..6043c904c4504 100644 --- a/nixos/modules/system/boot/loader/efi.nix +++ b/nixos/modules/system/boot/loader/efi.nix @@ -8,13 +8,13 @@ with lib; canTouchEfiVariables = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Whether the installation process is allowed to modify EFI boot variables."; + description = "Whether the installation process is allowed to modify EFI boot variables."; }; efiSysMountPoint = mkOption { default = "/boot"; type = types.str; - description = lib.mdDoc "Where the EFI System Partition is mounted."; + description = "Where the EFI System Partition is mounted."; }; }; } diff --git a/nixos/modules/system/boot/loader/external/external.nix b/nixos/modules/system/boot/loader/external/external.nix index 78982356a9ea8..7f976f755f2e4 100644 --- a/nixos/modules/system/boot/loader/external/external.nix +++ b/nixos/modules/system/boot/loader/external/external.nix @@ -12,11 +12,11 @@ in }; options.boot.loader.external = { - enable = mkEnableOption (lib.mdDoc "using an external tool to install your bootloader"); + enable = mkEnableOption "using an external tool to install your bootloader"; installHook = mkOption { type = with types; path; - description = lib.mdDoc '' + description = '' The full path to a program of your choosing which performs the bootloader installation process. The program will be called with an argument pointing to the output of the system's toplevel. diff --git a/nixos/modules/system/boot/loader/generations-dir/generations-dir.nix b/nixos/modules/system/boot/loader/generations-dir/generations-dir.nix index 5ace5dd06fd43..630c6e1870e6e 100644 --- a/nixos/modules/system/boot/loader/generations-dir/generations-dir.nix +++ b/nixos/modules/system/boot/loader/generations-dir/generations-dir.nix @@ -22,7 +22,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to create symlinks to the system generations under `/boot`. When enabled, `/boot/default/kernel`, @@ -41,7 +41,7 @@ in copyKernels = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether copy the necessary boot files into /boot, so /nix/store is not needed by the boot loader. ''; diff --git a/nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix b/nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix index 13df609071168..2b75707ad99ed 100644 --- a/nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix +++ b/nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix @@ -20,7 +20,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to generate an extlinux-compatible configuration file under `/boot/extlinux.conf`. For instance, U-Boot's generic distro boot support uses this file format. @@ -33,7 +33,7 @@ in useGenerationDeviceTree = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to generate Device Tree-related directives in the extlinux configuration. @@ -49,7 +49,7 @@ in default = 20; example = 10; type = types.int; - description = lib.mdDoc '' + description = '' Maximum number of configurations in the boot menu. ''; }; @@ -57,7 +57,7 @@ in populateCmd = mkOption { type = types.str; readOnly = true; - description = lib.mdDoc '' + description = '' Contains the builder command used to populate an image, honoring all options except the `-c <path-to-default-configuration>` argument. diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix index 0556c875241a1..fe340cfaedb67 100644 --- a/nixos/modules/system/boot/loader/grub/grub.nix +++ b/nixos/modules/system/boot/loader/grub/grub.nix @@ -126,7 +126,7 @@ in default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable the GNU GRUB boot loader. ''; }; @@ -140,7 +140,7 @@ in default = ""; example = "/dev/disk/by-id/wwn-0x500001234567890a"; type = types.str; - description = lib.mdDoc '' + description = '' The device on which the GRUB boot loader will be installed. The special value `nodev` means that a GRUB boot menu will be generated, but GRUB itself will not @@ -153,7 +153,7 @@ in default = []; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' The devices on which the boot loader, GRUB, will be installed. Can be used instead of `device` to install GRUB onto multiple devices. @@ -165,7 +165,7 @@ in example = { root = { hashedPasswordFile = "/path/to/file"; }; }; - description = lib.mdDoc '' + description = '' User accounts for GRUB. When specified, the GRUB command line and all boot options except the default are password-protected. All passwords and hashes provided will be stored in /boot/grub/grub.cfg, @@ -180,7 +180,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = lib.mdDoc '' + description = '' Specifies the path to a file containing the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be stored in /boot/grub/grub.cfg, and will @@ -191,7 +191,7 @@ in example = "grub.pbkdf2.sha512.10000.674DFFDEF76E13EA...2CC972B102CF4355"; default = null; type = with types; uniq (nullOr str); - description = lib.mdDoc '' + description = '' Specifies the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be copied to the Nix store, and will be visible to all local users. @@ -201,7 +201,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = lib.mdDoc '' + description = '' Specifies the path to a file containing the clear text password for the account. This password will be stored in /boot/grub/grub.cfg, and will @@ -212,7 +212,7 @@ in example = "Pa$$w0rd!"; default = null; type = with types; uniq (nullOr str); - description = lib.mdDoc '' + description = '' Specifies the clear text password for the account. This password will be copied to the Nix store, and will be visible to all local users. ''; @@ -227,7 +227,7 @@ in { path = "/boot1"; devices = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; } { path = "/boot2"; devices = [ "/dev/disk/by-id/wwn-0x500009876543210a" ]; } ]; - description = lib.mdDoc '' + description = '' Mirror the boot configuration to multiple partitions and install grub to the respective devices corresponding to those partitions. ''; @@ -238,7 +238,7 @@ in path = mkOption { example = "/boot1"; type = types.str; - description = lib.mdDoc '' + description = '' The path to the boot directory where GRUB will be written. Generally this boot path should double as an EFI path. ''; @@ -248,7 +248,7 @@ in default = null; example = "/boot1/efi"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The path to the efi system mount point. Usually this is the same partition as the above path and can be left as null. ''; @@ -258,7 +258,7 @@ in default = null; example = "NixOS-fsid"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The id of the bootloader to store in efi nvram. The default is to name it NixOS and append the path or efiSysMountPoint. This is only used if `boot.loader.efi.canTouchEfiVariables` is true. @@ -269,7 +269,7 @@ in default = [ ]; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" "/dev/disk/by-id/wwn-0x500009876543210a" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' The path to the devices which will have the GRUB MBR written. Note these are typically device paths and not paths to partitions. ''; @@ -283,7 +283,7 @@ in default = ""; example = "Stable 2.6.21"; type = types.str; - description = lib.mdDoc '' + description = '' GRUB entry name instead of default. ''; }; @@ -291,7 +291,7 @@ in storePath = mkOption { default = "/nix/store"; type = types.str; - description = lib.mdDoc '' + description = '' Path to the Nix store when looking for kernels at boot. Only makes sense when copyKernels is false. ''; @@ -300,7 +300,7 @@ in extraPrepareConfig = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Additional bash commands to be run at the script that prepares the GRUB menu entries. ''; @@ -314,7 +314,7 @@ in terminal_output --append serial ''; type = types.lines; - description = lib.mdDoc '' + description = '' Additional GRUB commands inserted in the configuration file just before the menu entries. ''; @@ -324,7 +324,7 @@ in default = [ ]; example = [ "--modules=nativedisk ahci pata part_gpt part_msdos diskfilter mdraid1x lvm ext2" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Additional arguments passed to `grub-install`. A use case for this is to build specific GRUB2 modules @@ -361,7 +361,7 @@ in export GNUPGHOME=$old_gpg_home ''; type = types.lines; - description = lib.mdDoc '' + description = '' Additional shell commands inserted in the bootloader installer script after generating menu entries. ''; @@ -371,7 +371,7 @@ in default = ""; example = "root (hd0)"; type = types.lines; - description = lib.mdDoc '' + description = '' Additional GRUB commands inserted in the configuration file at the start of each NixOS menu entry. ''; @@ -392,7 +392,7 @@ in chainloader /efi/fedora/grubx64.efi } ''; - description = lib.mdDoc '' + description = '' Any additional entries you want added to the GRUB boot menu. ''; }; @@ -400,7 +400,7 @@ in extraEntriesBeforeNixOS = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether extraEntries are included before the default option. ''; }; @@ -411,7 +411,7 @@ in example = literalExpression '' { "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; } ''; - description = lib.mdDoc '' + description = '' A set of files to be copied to {file}`/boot`. Each attribute name denotes the destination file name in {file}`/boot`, while the corresponding @@ -422,7 +422,7 @@ in useOSProber = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' If set to true, append entries for other OSs detected by os-prober. ''; }; @@ -430,7 +430,7 @@ in splashImage = mkOption { type = types.nullOr types.path; example = literalExpression "./my-background.png"; - description = lib.mdDoc '' + description = '' Background image used for GRUB. Set to `null` to run GRUB in text mode. @@ -446,7 +446,7 @@ in type = types.nullOr types.str; example = "#7EBAE4"; default = null; - description = lib.mdDoc '' + description = '' Background color to be used for GRUB to fill the areas the image isn't filling. ''; }; @@ -454,7 +454,7 @@ in timeoutStyle = mkOption { default = "menu"; type = types.enum [ "menu" "countdown" "hidden" ]; - description = lib.mdDoc '' + description = '' - `menu` shows the menu. - `countdown` uses a text-mode countdown. - `hidden` hides GRUB entirely. @@ -476,7 +476,7 @@ in entryOptions = mkOption { default = "--class nixos --unrestricted"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Options applied to the primary NixOS menu entry. ''; }; @@ -484,7 +484,7 @@ in subEntryOptions = mkOption { default = "--class nixos"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Options applied to the secondary NixOS submenu entry. ''; }; @@ -493,7 +493,7 @@ in type = types.nullOr types.path; example = literalExpression "pkgs.nixos-grub2-theme"; default = null; - description = lib.mdDoc '' + description = '' Grub theme to be used. ''; }; @@ -501,7 +501,7 @@ in splashMode = mkOption { type = types.enum [ "normal" "stretch" ]; default = "stretch"; - description = lib.mdDoc '' + description = '' Whether to stretch the image or show the image in the top-left corner unstretched. ''; }; @@ -510,7 +510,7 @@ in type = types.nullOr types.path; default = "${realGrub}/share/grub/unicode.pf2"; defaultText = literalExpression ''"''${pkgs.grub2}/share/grub/unicode.pf2"''; - description = lib.mdDoc '' + description = '' Path to a TrueType, OpenType, or pf2 font to be used by Grub. ''; }; @@ -519,7 +519,7 @@ in type = types.nullOr types.int; example = 16; default = null; - description = lib.mdDoc '' + description = '' Font size for the grub menu. Ignored unless `font` is set to a ttf or otf font. ''; @@ -529,7 +529,7 @@ in default = "auto"; example = "1024x768"; type = types.str; - description = lib.mdDoc '' + description = '' The gfxmode to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -538,7 +538,7 @@ in default = "1024x768"; example = "auto"; type = types.str; - description = lib.mdDoc '' + description = '' The gfxmode to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -547,7 +547,7 @@ in default = "keep"; example = "text"; type = types.str; - description = lib.mdDoc '' + description = '' The gfxpayload to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -556,7 +556,7 @@ in default = "text"; example = "keep"; type = types.str; - description = lib.mdDoc '' + description = '' The gfxpayload to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -565,7 +565,7 @@ in default = 100; example = 120; type = types.int; - description = lib.mdDoc '' + description = '' Maximum of configurations in boot menu. GRUB has problems when there are too many entries. ''; @@ -574,7 +574,7 @@ in copyKernels = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether the GRUB menu builder should copy kernels and initial ramdisks to /boot. This is done automatically if /boot is on a different partition than /. @@ -585,7 +585,7 @@ in default = "0"; type = types.either types.int types.str; apply = toString; - description = lib.mdDoc '' + description = '' Index of the default menu item to be booted. Can also be set to "saved", which will make GRUB select the menu item that was used at the last boot. @@ -595,7 +595,7 @@ in fsIdentifier = mkOption { default = "uuid"; type = types.enum [ "uuid" "label" "provided" ]; - description = lib.mdDoc '' + description = '' Determines how GRUB will identify devices when generating the configuration file. A value of uuid / label signifies that grub will always resolve the uuid or label of the device before using @@ -609,7 +609,7 @@ in zfsSupport = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether GRUB should be built against libzfs. ''; }; @@ -619,7 +619,7 @@ in internal = true; default = pkgs.zfs; defaultText = literalExpression "pkgs.zfs"; - description = lib.mdDoc '' + description = '' Which ZFS package to use if `config.boot.loader.grub.zfsSupport` is true. ''; }; @@ -627,7 +627,7 @@ in efiSupport = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether GRUB should be built with EFI support. ''; }; @@ -635,7 +635,7 @@ in efiInstallAsRemovable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to invoke `grub-install` with `--removable`. @@ -670,7 +670,7 @@ in enableCryptodisk = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enable support for encrypted partitions. GRUB should automatically unlock the correct encrypted partition and look for filesystems. ''; @@ -679,7 +679,7 @@ in forceInstall = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to try and forcibly install GRUB even if problems are detected. It is not recommended to enable this unless you know what you are doing. @@ -689,7 +689,7 @@ in forcei686 = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to force the use of a ia32 boot loader on x64 systems. Required to install and run NixOS on 64bit x86 systems with 32bit (U)EFI. ''; diff --git a/nixos/modules/system/boot/loader/grub/ipxe.nix b/nixos/modules/system/boot/loader/grub/ipxe.nix index d926b7ceaa6e6..8d9ab9966c545 100644 --- a/nixos/modules/system/boot/loader/grub/ipxe.nix +++ b/nixos/modules/system/boot/loader/grub/ipxe.nix @@ -27,8 +27,7 @@ in options = { boot.loader.grub.ipxe = mkOption { type = types.attrsOf (types.either types.path types.str); - description = - lib.mdDoc '' + description = '' Set of iPXE scripts available for booting from the GRUB boot menu. ''; diff --git a/nixos/modules/system/boot/loader/grub/memtest.nix b/nixos/modules/system/boot/loader/grub/memtest.nix index 8e68431ac571a..939d36666d217 100644 --- a/nixos/modules/system/boot/loader/grub/memtest.nix +++ b/nixos/modules/system/boot/loader/grub/memtest.nix @@ -16,7 +16,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Make Memtest86+, a memory testing program, available from the GRUB boot menu. ''; @@ -26,7 +26,7 @@ in default = []; example = [ "console=ttyS0,115200" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Parameters added to the Memtest86+ command line. As of memtest86+ 5.01 the following list of (apparently undocumented) parameters are accepted: diff --git a/nixos/modules/system/boot/loader/init-script/init-script.nix b/nixos/modules/system/boot/loader/init-script/init-script.nix index 4d33ed6b665b9..0f2a37bdd09fe 100644 --- a/nixos/modules/system/boot/loader/init-script/init-script.nix +++ b/nixos/modules/system/boot/loader/init-script/init-script.nix @@ -25,7 +25,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Some systems require a /sbin/init script which is started. Or having it makes starting NixOS easier. This applies to some kind of hosting services and user mode linux. diff --git a/nixos/modules/system/boot/loader/loader.nix b/nixos/modules/system/boot/loader/loader.nix index 0e33264271bf8..01475f79b9c25 100644 --- a/nixos/modules/system/boot/loader/loader.nix +++ b/nixos/modules/system/boot/loader/loader.nix @@ -12,7 +12,7 @@ with lib; boot.loader.timeout = mkOption { default = 5; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' Timeout (in seconds) until loader boots the default menu item. Use null if the loader menu should be displayed indefinitely. ''; }; diff --git a/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix b/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix index 9c9bee93de8ad..cf1f37bc62b84 100644 --- a/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix +++ b/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix @@ -48,7 +48,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to create files with the system generations in `/boot`. `/boot/old` will hold files from old generations. @@ -62,14 +62,14 @@ in version = mkOption { default = 2; type = types.enum [ 0 1 2 3 4 ]; - description = lib.mdDoc ""; + description = ""; }; uboot = { enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enable using uboot as bootmanager for the raspberry pi. ::: {.note} @@ -82,7 +82,7 @@ in default = 20; example = 10; type = types.int; - description = lib.mdDoc '' + description = '' Maximum number of configurations in the boot menu. ::: {.note} @@ -96,7 +96,7 @@ in firmwareConfig = mkOption { default = null; type = types.nullOr types.lines; - description = lib.mdDoc '' + description = '' Extra options that will be appended to `/boot/config.txt` file. For possible values, see: https://www.raspberrypi.com/documentation/computers/config_txt.html diff --git a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix index ba07506266e26..8b218cf1a6b2f 100644 --- a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix +++ b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix @@ -105,7 +105,7 @@ in { type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable the systemd-boot (formerly gummiboot) EFI boot manager. For more information about systemd-boot: https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/ @@ -146,7 +146,7 @@ in { type = types.bool; - description = lib.mdDoc '' + description = '' Whether to allow editing the kernel command-line before boot. It is recommended to set this to false, as it allows gaining root access by passing init=/bin/sh as a kernel @@ -158,7 +158,7 @@ in { xbootldrMountPoint = mkOption { default = null; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Where the XBOOTLDR partition is mounted. If set, this partition will be used as $BOOT to store boot loader entries and extra files @@ -171,7 +171,7 @@ in { default = null; example = 120; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' Maximum number of latest generations in the boot menu. Useful to prevent boot partition running out of disk space. @@ -188,7 +188,7 @@ in { sed -i "s|@INIT@|$init_value|g" /boot/custom/config_with_placeholder.conf ''; type = types.lines; - description = lib.mdDoc '' + description = '' Additional shell commands inserted in the bootloader installer script after generating menu entries. It can be used to expand on extra boot entries that cannot incorporate certain pieces of @@ -201,7 +201,7 @@ in { type = types.enum [ "0" "1" "2" "auto" "max" "keep" ]; - description = lib.mdDoc '' + description = '' The resolution of the console. The following values are valid: - `"0"`: Standard UEFI 80x25 mode @@ -217,7 +217,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Make Memtest86+ available from the systemd-boot menu. Memtest86+ is a program for testing memory. ''; @@ -226,7 +226,7 @@ in { sortKey = mkOption { default = "o_memtest86"; type = types.str; - description = lib.mdDoc '' + description = '' `systemd-boot` orders the menu entries by their sort keys, so if you want something to appear after all the NixOS entries, it should start with {file}`o` or onwards. @@ -240,7 +240,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Make `netboot.xyz` available from the `systemd-boot` menu. `netboot.xyz` is a menu system that allows you to boot OS installers and @@ -251,7 +251,7 @@ in { sortKey = mkOption { default = "o_netbootxyz"; type = types.str; - description = lib.mdDoc '' + description = '' `systemd-boot` orders the menu entries by their sort keys, so if you want something to appear after all the NixOS entries, it should start with {file}`o` or onwards. @@ -271,7 +271,7 @@ in { sort-key z_memtest '''; } ''; - description = lib.mdDoc '' + description = '' Any additional entries you want added to the `systemd-boot` menu. These entries will be copied to {file}`$BOOT/loader/entries`. Each attribute name denotes the destination file name, @@ -290,7 +290,7 @@ in { example = literalExpression '' { "efi/memtest86/memtest.efi" = "''${pkgs.memtest86plus}/memtest.efi"; } ''; - description = lib.mdDoc '' + description = '' A set of files to be copied to {file}`$BOOT`. Each attribute name denotes the destination file name in {file}`$BOOT`, while the corresponding @@ -303,7 +303,7 @@ in { type = types.bool; - description = lib.mdDoc '' + description = '' Invoke `bootctl install` with the `--graceful` option, which ignores errors when EFI variables cannot be written or when the EFI System Partition cannot be found. Currently only applies to random seed operations. diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index 3020734783e7a..65190e65d9b98 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -536,7 +536,7 @@ in boot.initrd.luks.mitigateDMAAttacks = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Unless enabled, encryption keys can be easily recovered by an attacker with physical access to any machine with PCMCIA, ExpressCard, ThunderBolt or FireWire port. More information is available at <https://en.wikipedia.org/wiki/DMA_attack>. @@ -553,7 +553,7 @@ in "serpent" "cbc" "xts" "lrw" "sha1" "sha256" "sha512" "af_alg" "algif_skcipher" ]; - description = lib.mdDoc '' + description = '' A list of cryptographic kernel modules needed to decrypt the root device(s). The default includes all common modules. ''; @@ -563,7 +563,7 @@ in type = types.bool; default = false; internal = true; - description = lib.mdDoc '' + description = '' Whether to configure luks support in the initrd, when no luks devices are configured. ''; @@ -572,7 +572,7 @@ in boot.initrd.luks.reusePassphrases = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' When opening a new LUKS device try reusing last successful passphrase. @@ -588,7 +588,7 @@ in boot.initrd.luks.devices = mkOption { default = { }; example = { luksroot.device = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; }; - description = lib.mdDoc '' + description = '' The encrypted disk that should be opened before the root filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM setups are supported. The unencrypted devices can be accessed as @@ -603,20 +603,20 @@ in default = name; example = "luksroot"; type = types.str; - description = lib.mdDoc "Name of the unencrypted device in {file}`/dev/mapper`."; + description = "Name of the unencrypted device in {file}`/dev/mapper`."; }; device = mkOption { example = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; type = types.str; - description = lib.mdDoc "Path of the underlying encrypted block device."; + description = "Path of the underlying encrypted block device."; }; header = mkOption { default = null; example = "/root/header.img"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The name of the file or block device that should be used as header for the encrypted device. ''; @@ -626,7 +626,7 @@ in default = null; example = "/dev/sdb1"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The name of the file (can be a raw device or a partition) that should be used as the decryption key for the encrypted device. If not specified, you will be prompted for a passphrase instead. @@ -636,7 +636,7 @@ in tryEmptyPassphrase = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' If keyFile fails then try an empty passphrase first before prompting for password. ''; @@ -646,7 +646,7 @@ in default = null; example = 5; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' The amount of time in seconds for a keyFile to appear before timing out and trying passwords. ''; @@ -656,7 +656,7 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' The size of the key file. Use this if only the beginning of the key file should be used as a key (often the case if a raw device or partition is used as key file). If not specified, the whole @@ -669,7 +669,7 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = lib.mdDoc '' + description = '' The offset of the key file. Use this in combination with `keyFileSize` to use part of a file as key file (often the case if a raw device or partition is used as a key file). @@ -682,13 +682,13 @@ in preLVM = mkOption { default = true; type = types.bool; - description = lib.mdDoc "Whether the luksOpen will be attempted before LVM scan or after it."; + description = "Whether the luksOpen will be attempted before LVM scan or after it."; }; allowDiscards = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. @@ -700,7 +700,7 @@ in bypassWorkqueues = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to bypass dm-crypt's internal read and write workqueues. Enabling this should improve performance on SSDs; see [here](https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance) @@ -711,7 +711,7 @@ in fallbackToPassword = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to fallback to interactive passphrase prompt if the keyfile cannot be found. This will prevent unattended boot should the keyfile go missing. @@ -720,7 +720,7 @@ in gpgCard = mkOption { default = null; - description = lib.mdDoc '' + description = '' The option to use this LUKS device with a GPG encrypted luks password by the GPG Smartcard. If null (the default), GPG-Smartcard will be disabled for this device. ''; @@ -730,17 +730,17 @@ in gracePeriod = mkOption { default = 10; type = types.int; - description = lib.mdDoc "Time in seconds to wait for the GPG Smartcard."; + description = "Time in seconds to wait for the GPG Smartcard."; }; encryptedPass = mkOption { type = types.path; - description = lib.mdDoc "Path to the GPG encrypted passphrase."; + description = "Path to the GPG encrypted passphrase."; }; publicKey = mkOption { type = types.path; - description = lib.mdDoc "Path to the Public Key."; + description = "Path to the Public Key."; }; }; }); @@ -751,14 +751,14 @@ in default = null; example = "f1d00200d8dc783f7fb1e10ace8da27f8312d72692abfca2f7e4960a73f48e82e1f7571f6ebfcee9fb434f9886ccc8fcc52a6614d8d2"; type = types.nullOr types.str; - description = lib.mdDoc "The FIDO2 credential ID."; + description = "The FIDO2 credential ID."; }; credentials = mkOption { default = []; example = [ "f1d00200d8dc783f7fb1e10ace8da27f8312d72692abfca2f7e4960a73f48e82e1f7571f6ebfcee9fb434f9886ccc8fcc52a6614d8d2" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' List of FIDO2 credential IDs. Use this if you have multiple FIDO2 keys you want to use for the same luks device. @@ -768,13 +768,13 @@ in gracePeriod = mkOption { default = 10; type = types.int; - description = lib.mdDoc "Time in seconds to wait for the FIDO2 key."; + description = "Time in seconds to wait for the FIDO2 key."; }; passwordLess = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Defines whatever to use an empty string as a default salt. Enable only when your device is PIN protected, such as [Trezor](https://trezor.io/). @@ -784,7 +784,7 @@ in yubikey = mkOption { default = null; - description = lib.mdDoc '' + description = '' The options to use for this LUKS device in YubiKey-PBA. If null (the default), YubiKey-PBA will be disabled for this device. ''; @@ -794,37 +794,37 @@ in twoFactor = mkOption { default = true; type = types.bool; - description = lib.mdDoc "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; + description = "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; }; slot = mkOption { default = 2; type = types.int; - description = lib.mdDoc "Which slot on the YubiKey to challenge."; + description = "Which slot on the YubiKey to challenge."; }; saltLength = mkOption { default = 16; type = types.int; - description = lib.mdDoc "Length of the new salt in byte (64 is the effective maximum)."; + description = "Length of the new salt in byte (64 is the effective maximum)."; }; keyLength = mkOption { default = 64; type = types.int; - description = lib.mdDoc "Length of the LUKS slot key derived with PBKDF2 in byte."; + description = "Length of the LUKS slot key derived with PBKDF2 in byte."; }; iterationStep = mkOption { default = 0; type = types.int; - description = lib.mdDoc "How much the iteration count for PBKDF2 is increased at each successful authentication."; + description = "How much the iteration count for PBKDF2 is increased at each successful authentication."; }; gracePeriod = mkOption { default = 10; type = types.int; - description = lib.mdDoc "Time in seconds to wait for the YubiKey."; + description = "Time in seconds to wait for the YubiKey."; }; /* TODO: Add to the documentation of the current module: @@ -835,7 +835,7 @@ in device = mkOption { default = "/dev/sda1"; type = types.path; - description = lib.mdDoc '' + description = '' An unencrypted device that will temporarily be mounted in stage-1. Must contain the current salt to create the challenge for this LUKS device. ''; @@ -844,13 +844,13 @@ in fsType = mkOption { default = "vfat"; type = types.str; - description = lib.mdDoc "The filesystem of the unencrypted device."; + description = "The filesystem of the unencrypted device."; }; path = mkOption { default = "/crypt-storage/default"; type = types.str; - description = lib.mdDoc '' + description = '' Absolute path of the salt on the unencrypted device with that device's root directory as "/". ''; @@ -867,7 +867,7 @@ in mkdir -p /tmp/persistent mount -t zfs rpool/safe/persistent /tmp/persistent ''; - description = lib.mdDoc '' + description = '' Commands that should be run right before we try to mount our LUKS device. This can be useful, if the keys needed to open the drive is on another partition. ''; @@ -879,7 +879,7 @@ in example = '' umount /tmp/persistent ''; - description = lib.mdDoc '' + description = '' Commands that should be run right after we have mounted our LUKS device. ''; }; @@ -889,7 +889,7 @@ in default = []; example = [ "_netdev" ]; visible = false; - description = lib.mdDoc '' + description = '' Only used with systemd stage 1. Extra options to append to the last column of the generated crypttab file. @@ -915,7 +915,7 @@ in boot.initrd.luks.gpgSupport = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enables support for authenticating with a GPG encrypted password. ''; }; @@ -923,7 +923,7 @@ in boot.initrd.luks.yubikeySupport = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enables support for authenticating with a YubiKey on LUKS devices. See the NixOS wiki for information on how to properly setup a LUKS device and a YubiKey to work with this feature. @@ -933,7 +933,7 @@ in boot.initrd.luks.fido2Support = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enables support for authenticating with FIDO2 devices. ''; }; diff --git a/nixos/modules/system/boot/modprobe.nix b/nixos/modules/system/boot/modprobe.nix index d751c4462d3f1..f0ced41fec4c4 100644 --- a/nixos/modules/system/boot/modprobe.nix +++ b/nixos/modules/system/boot/modprobe.nix @@ -7,7 +7,7 @@ with lib; ###### interface options = { - boot.modprobeConfig.enable = mkEnableOption (lib.mdDoc "modprobe config. This is useful for systems like containers which do not require a kernel") // { + boot.modprobeConfig.enable = mkEnableOption "modprobe config. This is useful for systems like containers which do not require a kernel" // { default = true; }; @@ -15,7 +15,7 @@ with lib; type = types.listOf types.str; default = []; example = [ "cirrusfb" "i2c_piix4" ]; - description = lib.mdDoc '' + description = '' List of names of kernel modules that should not be loaded automatically by the hardware probing code. ''; @@ -27,7 +27,7 @@ with lib; '' options parport_pc io=0x378 irq=7 dma=1 ''; - description = lib.mdDoc '' + description = '' Any additional configuration to be appended to the generated {file}`modprobe.conf`. This is typically used to specify module options. See diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index 9b0d750d12ce2..0ddb7dcb651de 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -1508,7 +1508,7 @@ let enable = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to manage network configuration using {command}`systemd-network`. This also enables {option}`systemd.networkd.enable`. @@ -1519,7 +1519,7 @@ let default = {}; example = { Name = "eth0"; }; type = types.attrsOf unitOption; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Match]` section of the unit. See {manpage}`systemd.link(5)` @@ -1532,7 +1532,7 @@ let extraConfig = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "Extra configuration append to unit"; + description = "Extra configuration append to unit"; }; }; @@ -1541,7 +1541,7 @@ let default = {}; example = { SpeedMeter = true; ManageForeignRoutingPolicyRules = false; }; type = types.addCheck (types.attrsOf unitOption) check.global.sectionNetwork; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Network]` section of the networkd config. See {manpage}`networkd.conf(5)` for details. @@ -1552,7 +1552,7 @@ let default = {}; example = { DUIDType = "vendor"; }; type = types.addCheck (types.attrsOf unitOption) check.global.sectionDHCPv4; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPv4]` section of the networkd config. See {manpage}`networkd.conf(5)` for details. @@ -1563,7 +1563,7 @@ let default = {}; example = { DUIDType = "vendor"; }; type = types.addCheck (types.attrsOf unitOption) check.global.sectionDHCPv6; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPv6]` section of the networkd config. See {manpage}`networkd.conf(5)` for details. @@ -1576,7 +1576,7 @@ let enable = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable this .link unit. It's handled by udev no matter if {command}`systemd-networkd` is enabled or not ''; }; @@ -1585,7 +1585,7 @@ let default = {}; example = { MACAddress = "00:ff:ee:aa:cc:dd"; }; type = types.addCheck (types.attrsOf unitOption) check.link.sectionLink; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Link]` section of the unit. See {manpage}`systemd.link(5)` for details. @@ -1600,7 +1600,7 @@ let l2tpSessionConfig = mkOption { default = {}; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionL2TPSession; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[L2TPSession]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1614,7 +1614,7 @@ let wireguardPeerConfig = mkOption { default = {}; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionWireGuardPeer; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[WireGuardPeer]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1628,7 +1628,7 @@ let netdevConfig = mkOption { example = { Name = "mybridge"; Kind = "bridge"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionNetdev; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Netdev]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1639,7 +1639,7 @@ let default = {}; example = { Id = 4; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionVLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[VLAN]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1650,7 +1650,7 @@ let default = {}; example = { Mode = "L2"; Flags = "private"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionIPVLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPVLAN]` section of the unit. See {manpage}`systemd.netdev(5)` for details. ''; @@ -1660,7 +1660,7 @@ let default = {}; example = { Mode = "L3"; Flags = "vepa"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionIPVTAP; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPVTAP]` section of the unit. See {manpage}`systemd.netdev(5)` for details. ''; @@ -1670,7 +1670,7 @@ let default = {}; example = { Mode = "private"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionMACVLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[MACVLAN]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1680,7 +1680,7 @@ let vxlanConfig = mkOption { default = {}; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionVXLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[VXLAN]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1691,7 +1691,7 @@ let default = {}; example = { Remote = "192.168.1.1"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionTunnel; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Tunnel]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1702,7 +1702,7 @@ let default = { }; example = { Port = 9001; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionFooOverUDP; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[FooOverUDP]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1713,7 +1713,7 @@ let default = {}; example = { Name = "veth2"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionPeer; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Peer]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1724,7 +1724,7 @@ let default = {}; example = { User = "openvpn"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionTun; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Tun]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1735,7 +1735,7 @@ let default = {}; example = { User = "openvpn"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionTap; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Tap]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1752,7 +1752,7 @@ let EncapsulationType = "ip"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionL2TP; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[L2TP]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1767,7 +1767,7 @@ let Name = "l2tp-sess"; };}]; type = with types; listOf (submodule l2tpSessionOptions); - description = lib.mdDoc '' + description = '' Each item in this array specifies an option in the `[L2TPSession]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1782,7 +1782,7 @@ let FirewallMark = 42; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionWireGuard; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[WireGuard]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1802,7 +1802,7 @@ let PersistentKeepalive = 15; };}]; type = with types; listOf (submodule wireguardPeerOptions); - description = lib.mdDoc '' + description = '' Each item in this array specifies an option in the `[WireGuardPeer]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1816,7 +1816,7 @@ let default = {}; example = { Mode = "802.3ad"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionBond; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Bond]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1827,7 +1827,7 @@ let default = {}; example = { InterfaceId = 1; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionXfrm; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Xfrm]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1838,7 +1838,7 @@ let default = {}; example = { Table = 2342; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionVRF; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[VRF]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1851,7 +1851,7 @@ let default = {}; example = { PhysicalDevice = 0; Type = "station"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionWLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[WLAN]` section of the unit. See {manpage}`systemd.netdev(5)` for details. ''; @@ -1864,7 +1864,7 @@ let RoutingAlgorithm = "batman-v"; }; type = types.addCheck (types.attrsOf unitOption) check.netdev.sectionBatmanAdvanced; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[BatmanAdvanced]` section of the unit. See {manpage}`systemd.netdev(5)` for details. @@ -1878,7 +1878,7 @@ let addressConfig = mkOption { example = { Address = "192.168.0.100/24"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionAddress; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Address]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1893,7 +1893,7 @@ let default = { }; example = { Table = 10; IncomingInterface = "eth1"; Family = "both"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionRoutingPolicyRule; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[RoutingPolicyRule]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1908,7 +1908,7 @@ let default = {}; example = { Gateway = "192.168.0.1"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionRoute; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Route]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1923,7 +1923,7 @@ let default = {}; example = { Prefix = "fd00::/64"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionIPv6Prefix; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPv6Prefix]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1938,7 +1938,7 @@ let default = {}; example = { Route = "fd00::/64"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionIPv6RoutePrefix; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPv6RoutePrefix]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1953,7 +1953,7 @@ let default = {}; example = { MACAddress = "65:43:4a:5b:d8:5f"; Address = "192.168.1.42"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDHCPServerStaticLease; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPServerStaticLease]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1971,7 +1971,7 @@ let default = {}; example = { MACAddress = "65:43:4a:5b:d8:5f"; Destination = "192.168.1.42"; VNI = 20; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionBridgeFDB; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[BridgeFDB]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -1986,7 +1986,7 @@ let default = {}; example = { MulticastGroupAddress = "ff02::1:2:3:4"; VLANId = 10; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionBridgeMDB; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[BridgeMDB]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2001,7 +2001,7 @@ let default = {}; example = { VLAN = 20; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionBridgeVLAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[BridgeVLAN]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2016,7 +2016,7 @@ let default = {}; example = { Unmanaged = true; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionLink; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Link]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2027,7 +2027,7 @@ let default = {}; example = { Description = "My Network"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionNetwork; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Network]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2045,7 +2045,7 @@ let default = {}; example = { UseDNS = true; UseRoutes = true; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDHCPv4; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPv4]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2056,7 +2056,7 @@ let default = {}; example = { UseDNS = true; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDHCPv6; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPv6]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2072,7 +2072,7 @@ let default = {}; example = { SubnetId = "auto"; Announce = true; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDHCPPrefixDelegation; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPPrefixDelegation]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2083,7 +2083,7 @@ let default = {}; example = { UseDNS = true; DHCPv6Client = "always"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionIPv6AcceptRA; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPv6AcceptRA]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2094,7 +2094,7 @@ let default = {}; example = { PoolOffset = 50; EmitDNS = false; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDHCPServer; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DHCPServer]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2112,7 +2112,7 @@ let default = {}; example = { EmitDNS = true; Managed = true; OtherInformation = true; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionIPv6SendRA; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPv6SendRA]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2123,7 +2123,7 @@ let default = []; example = [ { dhcpServerStaticLeaseConfig = { MACAddress = "65:43:4a:5b:d8:5f"; Address = "192.168.1.42"; }; } ]; type = with types; listOf (submodule dhcpServerStaticLeaseOptions); - description = lib.mdDoc '' + description = '' A list of DHCPServerStaticLease sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2133,7 +2133,7 @@ let default = []; example = [ { ipv6PrefixConfig = { AddressAutoconfiguration = true; OnLink = true; }; } ]; type = with types; listOf (submodule ipv6PrefixOptions); - description = lib.mdDoc '' + description = '' A list of ipv6Prefix sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2143,7 +2143,7 @@ let default = []; example = [ { ipv6RoutePrefixConfig = { Route = "fd00::/64"; LifetimeSec = 3600; }; } ]; type = with types; listOf (submodule ipv6RoutePrefixOptions); - description = lib.mdDoc '' + description = '' A list of ipv6RoutePrefix sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2153,7 +2153,7 @@ let default = {}; example = { MulticastFlood = false; Cost = 20; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionBridge; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Bridge]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2164,7 +2164,7 @@ let default = []; example = [ { bridgeFDBConfig = { MACAddress = "90:e2:ba:43:fc:71"; Destination = "192.168.100.4"; VNI = 3600; }; } ]; type = with types; listOf (submodule bridgeFDBOptions); - description = lib.mdDoc '' + description = '' A list of BridgeFDB sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2174,7 +2174,7 @@ let default = []; example = [ { bridgeMDBConfig = { MulticastGroupAddress = "ff02::1:2:3:4"; VLANId = 10; } ; } ]; type = with types; listOf (submodule bridgeMDBOptions); - description = lib.mdDoc '' + description = '' A list of BridgeMDB sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2184,7 +2184,7 @@ let default = {}; example = { MUDURL = "https://things.example.org/product_abc123/v5"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionLLDP; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[LLDP]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2195,7 +2195,7 @@ let default = {}; example = { }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionCAN; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[CAN]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2206,7 +2206,7 @@ let default = {}; example = { }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionIPoIB; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[IPoIB]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2217,7 +2217,7 @@ let default = {}; example = { Parent = "ingress"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionQDisc; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[QDisc]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2228,7 +2228,7 @@ let default = {}; example = { Parent = "ingress"; DelaySec = "20msec"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionNetworkEmulator; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[NetworkEmulator]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2239,7 +2239,7 @@ let default = {}; example = { Parent = "ingress"; Rate = "100k"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionTokenBucketFilter; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[TokenBucketFilter]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2250,7 +2250,7 @@ let default = {}; example = { Parent = "ingress"; PacketLimit = "3847"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionPIE; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[PIE]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2261,7 +2261,7 @@ let default = {}; example = { Parent = "ingress"; PacketLimit = "3847"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionFlowQueuePIE; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[FlowQueuePIE]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2272,7 +2272,7 @@ let default = {}; example = { Parent = "ingress"; PacketLimit = "3847"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionStochasticFairBlue; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[StochasticFairBlue]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2283,7 +2283,7 @@ let default = {}; example = { Parent = "ingress"; PerturbPeriodSec = "30"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionStochasticFairnessQueueing; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[StochasticFairnessQueueing]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2294,7 +2294,7 @@ let default = {}; example = { Parent = "ingress"; LimitBytes = "20K"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionBFIFO; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[BFIFO]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2305,7 +2305,7 @@ let default = {}; example = { Parent = "ingress"; PacketLimit = "300"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionPFIFO; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[PFIFO]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2316,7 +2316,7 @@ let default = {}; example = { Parent = "ingress"; PacketLimit = "300"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionPFIFOHeadDrop; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[PFIFOHeadDrop]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2327,7 +2327,7 @@ let default = {}; example = { Parent = "ingress"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionPFIFOFast; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[PFIFOFast]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2338,7 +2338,7 @@ let default = {}; example = { Bandwidth = "40M"; OverheadBytes = 8; CompensationMode = "ptm"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionCAKE; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[CAKE]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2349,7 +2349,7 @@ let default = {}; example = { Parent = "ingress"; TargetSec = "20msec"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionControlledDelay; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[ControlledDelay]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2360,7 +2360,7 @@ let default = {}; example = { Parent = "root"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDeficitRoundRobinScheduler; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DeficitRoundRobinScheduler]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2371,7 +2371,7 @@ let default = {}; example = { Parent = "root"; QuantumBytes = "300k"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionDeficitRoundRobinSchedulerClass; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[DeficitRoundRobinSchedulerClass]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2382,7 +2382,7 @@ let default = {}; example = { Parent = "root"; QuantumBytes = "300k"; Bands = 3; PriorityMap = "100 200 300"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionEnhancedTransmissionSelection; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[EnhancedTransmissionSelection]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2393,7 +2393,7 @@ let default = {}; example = { Parent = "root"; VirtualQueues = 5; DefaultVirtualQueue = 3; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionGenericRandomEarlyDetection; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[GenericRandomEarlyDetection]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2404,7 +2404,7 @@ let default = {}; example = { Parent = "root"; Flows = 5; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionFairQueueingControlledDelay; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[FairQueueingControlledDelay]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2415,7 +2415,7 @@ let default = {}; example = { Parent = "root"; FlowLimit = 5; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionFairQueueing; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[FairQueueing]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2426,7 +2426,7 @@ let default = {}; example = { Parent = "root"; Id = 0; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionTrivialLinkEqualizer; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[TrivialLinkEqualizer]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2437,7 +2437,7 @@ let default = {}; example = { Parent = "root"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionHierarchyTokenBucket; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[HierarchyTokenBucket]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2448,7 +2448,7 @@ let default = {}; example = { Parent = "root"; Rate = "10M"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionHierarchyTokenBucketClass; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[HierarchyTokenBucketClass]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2459,7 +2459,7 @@ let default = {}; example = { Parent = "root"; PacketLimit = 10000; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionHeavyHitterFilter; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[HeavyHitterFilter]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2470,7 +2470,7 @@ let default = {}; example = { Parent = "root"; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionQuickFairQueueing; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[QuickFairQueueing]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2481,7 +2481,7 @@ let default = {}; example = { Parent = "root"; Weight = 133; }; type = types.addCheck (types.attrsOf unitOption) check.network.sectionQuickFairQueueingClass; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[QuickFairQueueingClass]` section of the unit. See {manpage}`systemd.network(5)` for details. @@ -2492,7 +2492,7 @@ let default = []; example = [ { bridgeVLANConfig = { VLAN = "10-20"; }; } ]; type = with types; listOf (submodule bridgeVLANOptions); - description = lib.mdDoc '' + description = '' A list of BridgeVLAN sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2501,7 +2501,7 @@ let name = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' The name of the network interface to match against. ''; }; @@ -2509,7 +2509,7 @@ let DHCP = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Whether to enable DHCP on the interfaces matched. ''; }; @@ -2517,7 +2517,7 @@ let domains = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = lib.mdDoc '' + description = '' A list of domains to pass to the network config. ''; }; @@ -2525,7 +2525,7 @@ let address = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of addresses to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2534,7 +2534,7 @@ let gateway = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of gateways to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2543,7 +2543,7 @@ let dns = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of dns servers to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2552,7 +2552,7 @@ let ntp = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of ntp servers to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2561,7 +2561,7 @@ let bridge = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of bridge interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2570,7 +2570,7 @@ let bond = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of bond interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2579,7 +2579,7 @@ let vrf = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of vrf interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2588,7 +2588,7 @@ let vlan = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of vlan interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2597,7 +2597,7 @@ let macvlan = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of macvlan interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2606,7 +2606,7 @@ let macvtap = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of macvtap interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2615,7 +2615,7 @@ let vxlan = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of vxlan interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2624,7 +2624,7 @@ let tunnel = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of tunnel interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2633,7 +2633,7 @@ let xfrm = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of xfrm interfaces to be added to the network section of the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2642,7 +2642,7 @@ let addresses = mkOption { default = [ ]; type = with types; listOf (submodule addressOptions); - description = lib.mdDoc '' + description = '' A list of address sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2651,7 +2651,7 @@ let routingPolicyRules = mkOption { default = [ ]; type = with types; listOf (submodule routingPolicyRulesOptions); - description = lib.mdDoc '' + description = '' A list of routing policy rules sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2660,7 +2660,7 @@ let routes = mkOption { default = [ ]; type = with types; listOf (submodule routeOptions); - description = lib.mdDoc '' + description = '' A list of route sections to be added to the unit. See {manpage}`systemd.network(5)` for details. ''; @@ -2687,7 +2687,7 @@ let default = {}; example = { foo = 27; }; type = with types; attrsOf int; - description = lib.mdDoc '' + description = '' Defines route table names as an attrset of name to number. See {manpage}`networkd.conf(5)` for details. ''; @@ -2697,7 +2697,7 @@ let default = true; example = false; type = types.bool; - description = lib.mdDoc '' + description = '' If true and routeTables are set, then the specified route tables will also be installed into /etc/iproute2/rt_tables. ''; @@ -2737,7 +2737,7 @@ let enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable networkd or not. ''; }; @@ -2746,32 +2746,32 @@ let default = {}; inherit visible; type = with types; attrsOf (submodule [ { options = linkOptions; } ]); - description = lib.mdDoc "Definition of systemd network links."; + description = "Definition of systemd network links."; }; netdevs = mkOption { default = {}; inherit visible; type = with types; attrsOf (submodule [ { options = netdevOptions; } ]); - description = lib.mdDoc "Definition of systemd network devices."; + description = "Definition of systemd network devices."; }; networks = mkOption { default = {}; inherit visible; type = with types; attrsOf (submodule [ { options = networkOptions; } networkConfig ]); - description = lib.mdDoc "Definition of systemd networks."; + description = "Definition of systemd networks."; }; config = mkOption { default = {}; inherit visible; type = with types; submodule [ { options = networkdOptions; } networkdConfig ]; - description = lib.mdDoc "Definition of global systemd network config."; + description = "Definition of global systemd network config."; }; units = mkOption { - description = lib.mdDoc "Definition of networkd units."; + description = "Definition of networkd units."; default = {}; internal = true; type = with types; attrsOf (submodule ( @@ -2788,7 +2788,7 @@ let type = types.bool; default = true; example = false; - description = lib.mdDoc '' + description = '' Whether to enable the systemd-networkd-wait-online service. systemd-networkd-wait-online can timeout and fail if there are no network interfaces @@ -2799,7 +2799,7 @@ let ''; }; anyInterface = mkOption { - description = lib.mdDoc '' + description = '' Whether to consider the network online when any interface is online, as opposed to all of them. This is useful on portable machines with a wired and a wireless interface, for example. @@ -2811,7 +2811,7 @@ let }; ignoredInterfaces = mkOption { - description = lib.mdDoc '' + description = '' Network interfaces to be ignored when deciding if the system is online. ''; type = with types; listOf str; @@ -2820,7 +2820,7 @@ let }; timeout = mkOption { - description = lib.mdDoc '' + description = '' Time to wait for the network to come online, in seconds. Set to 0 to disable. ''; type = types.ints.unsigned; @@ -2829,7 +2829,7 @@ let }; extraArgs = mkOption { - description = lib.mdDoc '' + description = '' Extra command-line arguments to pass to systemd-networkd-wait-online. These also affect per-interface `systemd-network-wait-online@` services. diff --git a/nixos/modules/system/boot/plymouth.nix b/nixos/modules/system/boot/plymouth.nix index 85f0fd4622df1..4fed6335f7421 100644 --- a/nixos/modules/system/boot/plymouth.nix +++ b/nixos/modules/system/boot/plymouth.nix @@ -61,13 +61,13 @@ in boot.plymouth = { - enable = mkEnableOption (lib.mdDoc "Plymouth boot splash screen"); + enable = mkEnableOption "Plymouth boot splash screen"; font = mkOption { default = "${pkgs.dejavu_fonts.minimal}/share/fonts/truetype/DejaVuSans.ttf"; defaultText = literalExpression ''"''${pkgs.dejavu_fonts.minimal}/share/fonts/truetype/DejaVuSans.ttf"''; type = types.path; - description = lib.mdDoc '' + description = '' Font file made available for displaying text on the splash screen. ''; }; @@ -80,7 +80,7 @@ in `[ ]`. ''; type = types.listOf types.package; - description = lib.mdDoc '' + description = '' Extra theme packages for plymouth. ''; }; @@ -88,7 +88,7 @@ in theme = mkOption { default = "bgrt"; type = types.str; - description = lib.mdDoc '' + description = '' Splash screen theme. ''; }; @@ -104,7 +104,7 @@ in sha256 = "1ivzgd7iz0i06y36p8m5w48fd8pjqwxhdaavc0pxs7w1g7mcy5si"; } ''; - description = lib.mdDoc '' + description = '' Logo which is displayed on the splash screen. Currently supports PNG file format only. ''; @@ -113,7 +113,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Literal string to append to `configFile` and the config file generated by the plymouth module. ''; diff --git a/nixos/modules/system/boot/resolved.nix b/nixos/modules/system/boot/resolved.nix index c42c88163c564..64a15179438fe 100644 --- a/nixos/modules/system/boot/resolved.nix +++ b/nixos/modules/system/boot/resolved.nix @@ -15,7 +15,7 @@ in services.resolved.enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable the systemd DNS resolver daemon, `systemd-resolved`. Search for `services.resolved` to see all options. @@ -26,7 +26,7 @@ in default = null; example = [ "8.8.8.8" "2001:4860:4860::8844" ]; type = types.nullOr (types.listOf types.str); - description = lib.mdDoc '' + description = '' A list of IPv4 and IPv6 addresses to use as the fallback DNS servers. If this option is null, a compiled-in list of DNS servers is used instead. Setting this option to an empty list will override the built-in list to an empty list, disabling fallback. @@ -38,7 +38,7 @@ in defaultText = literalExpression "config.networking.search"; example = [ "example.com" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of domains. These domains are used as search suffixes when resolving single-label host names (domain names which contain no dot), in order to qualify them into fully-qualified @@ -55,7 +55,7 @@ in default = "true"; example = "false"; type = types.enum [ "true" "resolve" "false" ]; - description = lib.mdDoc '' + description = '' Controls Link-Local Multicast Name Resolution support (RFC 4795) on the local host. @@ -70,7 +70,7 @@ in default = "false"; example = "true"; type = types.enum [ "true" "allow-downgrade" "false" ]; - description = lib.mdDoc '' + description = '' If set to - `"true"`: all DNS lookups are DNSSEC-validated locally (excluding @@ -99,7 +99,7 @@ in default = "false"; example = "true"; type = types.enum [ "true" "opportunistic" "false" ]; - description = lib.mdDoc '' + description = '' If set to - `"true"`: all DNS lookups will be encrypted. This requires @@ -121,7 +121,7 @@ in services.resolved.extraConfig = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Extra config to append to resolved.conf. ''; }; diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix index 02a3f5113cc0a..ae05bc5ae88c4 100644 --- a/nixos/modules/system/boot/stage-1.nix +++ b/nixos/modules/system/boot/stage-1.nix @@ -444,7 +444,7 @@ in type = types.str; default = ""; example = "/dev/sda3"; - description = lib.mdDoc '' + description = '' Device for manual resume attempt during boot. This should be used primarily if you want to resume from file. If left empty, the swap partitions are used. Specify here the device where the file resides. @@ -457,7 +457,7 @@ in type = types.bool; default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; - description = lib.mdDoc '' + description = '' Whether to enable the NixOS initial RAM disk (initrd). This may be needed to perform some initialisation tasks (like mounting network/encrypted file systems) before continuing the boot process. @@ -471,11 +471,11 @@ in options = { source = mkOption { type = types.package; - description = lib.mdDoc "The object to make available inside the initrd."; + description = "The object to make available inside the initrd."; }; }; }); - description = lib.mdDoc '' + description = '' Extra files to link and copy in to the initrd. ''; }; @@ -483,7 +483,7 @@ in boot.initrd.prepend = mkOption { default = [ ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Other initrd files to prepend to the final initrd we are building. ''; }; @@ -491,7 +491,7 @@ in boot.initrd.checkJournalingFS = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to run {command}`fsck` on journaling filesystems such as ext3. ''; }; @@ -499,7 +499,7 @@ in boot.initrd.preLVMCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed immediately before LVM discovery. ''; }; @@ -507,7 +507,7 @@ in boot.initrd.preDeviceCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed before udev is started to create device nodes. ''; @@ -516,7 +516,7 @@ in boot.initrd.postDeviceCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed immediately after stage 1 of the boot has loaded kernel modules and created device nodes in {file}`/dev`. @@ -526,7 +526,7 @@ in boot.initrd.postResumeCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed immediately after attempting to resume. ''; }; @@ -534,7 +534,7 @@ in boot.initrd.postMountCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed immediately after the stage 1 filesystems have been mounted. ''; @@ -543,7 +543,7 @@ in boot.initrd.preFailCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed before the failure prompt is shown. ''; }; @@ -552,7 +552,7 @@ in internal = true; default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed in the builder of the extra-utils derivation. This can be used to provide additional utilities in the initial ramdisk. @@ -563,7 +563,7 @@ in internal = true; default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed in the builder of the extra-utils derivation after patchelf has done its job. This can be used to test additional utilities @@ -575,7 +575,7 @@ in internal = true; default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed in the builder of the udev-rules derivation. This can be used to add additional udev rules in the initial ramdisk. @@ -590,7 +590,7 @@ in ); defaultText = literalMD "`zstd` if the kernel supports it (5.9+), `gzip` if not"; type = types.either types.str (types.functionTo types.str); - description = lib.mdDoc '' + description = '' The compressor to use on the initrd image. May be any of: - The name of one of the predefined compressors, see {file}`pkgs/build-support/kernel/initrd-compressor-meta.nix` for the definitions. @@ -605,14 +605,13 @@ in boot.initrd.compressorArgs = mkOption { default = null; type = types.nullOr (types.listOf types.str); - description = lib.mdDoc "Arguments to pass to the compressor for the initrd image, or null to use the compressor's defaults."; + description = "Arguments to pass to the compressor for the initrd image, or null to use the compressor's defaults."; }; boot.initrd.secrets = mkOption { default = {}; type = types.attrsOf (types.nullOr types.path); - description = - lib.mdDoc '' + description = '' Secrets to append to the initrd. The attribute name is the path the secret should have inside the initrd, the value is the path it should be copied from (or null for the same @@ -639,8 +638,7 @@ in boot.initrd.verbose = mkOption { default = true; type = types.bool; - description = - lib.mdDoc '' + description = '' Verbosity of the initrd. Please note that disabling verbosity removes only the mandatory messages generated by the NixOS scripts. For a completely silent boot, you might also want to set the two following @@ -655,8 +653,7 @@ in { internal = true; default = false; type = types.bool; - description = - lib.mdDoc '' + description = '' Whether the bootloader setup runs append-initrd-secrets. If not, any needed secrets must be copied into the initrd and thus added to the store. @@ -668,7 +665,7 @@ in options.neededForBoot = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' If set, this file system will be mounted in the initial ramdisk. Note that the file system will always be mounted in the initial ramdisk if its mount point is one of the following: diff --git a/nixos/modules/system/boot/stage-2.nix b/nixos/modules/system/boot/stage-2.nix index 001380158d5fc..71ee9144990cb 100644 --- a/nixos/modules/system/boot/stage-2.nix +++ b/nixos/modules/system/boot/stage-2.nix @@ -37,7 +37,7 @@ in default = ""; example = "rm -f /var/log/messages"; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to be executed just before systemd is started. ''; }; @@ -45,7 +45,7 @@ in readOnlyNixStore = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' If set, NixOS will enforce the immutability of the Nix store by making {file}`/nix/store` a read-only bind mount. Nix will automatically make the store writable when @@ -56,7 +56,7 @@ in systemdExecutable = mkOption { default = "/run/current-system/systemd/lib/systemd/systemd"; type = types.str; - description = lib.mdDoc '' + description = '' The program to execute to start systemd. ''; }; @@ -64,7 +64,7 @@ in extraSystemdUnitPaths = mkOption { default = []; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Additional paths that get appended to the SYSTEMD_UNIT_PATH environment variable that can contain mutable unit files. ''; diff --git a/nixos/modules/system/boot/systemd/coredump.nix b/nixos/modules/system/boot/systemd/coredump.nix index 271d8f86d0e61..1f29f6686d0d0 100644 --- a/nixos/modules/system/boot/systemd/coredump.nix +++ b/nixos/modules/system/boot/systemd/coredump.nix @@ -10,7 +10,7 @@ in { systemd.coredump.enable = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether core dumps should be processed by {command}`systemd-coredump`. If disabled, core dumps appear in the current directory of the crashing process. @@ -21,7 +21,7 @@ in { default = ""; type = types.lines; example = "Storage=journal"; - description = lib.mdDoc '' + description = '' Extra config options for systemd-coredump. See coredump.conf(5) man page for available options. ''; diff --git a/nixos/modules/system/boot/systemd/homed.nix b/nixos/modules/system/boot/systemd/homed.nix index b216820c0c0cd..1fd8846616c9b 100644 --- a/nixos/modules/system/boot/systemd/homed.nix +++ b/nixos/modules/system/boot/systemd/homed.nix @@ -4,9 +4,9 @@ let cfg = config.services.homed; in { - options.services.homed.enable = lib.mkEnableOption (lib.mdDoc '' + options.services.homed.enable = lib.mkEnableOption '' systemd home area/user account manager - ''); + ''; config = lib.mkIf cfg.enable { assertions = [ diff --git a/nixos/modules/system/boot/systemd/initrd.nix b/nixos/modules/system/boot/systemd/initrd.nix index 6546b500ed981..00441b693d670 100644 --- a/nixos/modules/system/boot/systemd/initrd.nix +++ b/nixos/modules/system/boot/systemd/initrd.nix @@ -117,8 +117,8 @@ let in { options.boot.initrd.systemd = { - enable = mkEnableOption (lib.mdDoc "systemd in initrd") // { - description = lib.mdDoc '' + enable = mkEnableOption "systemd in initrd" // { + description = '' Whether to enable systemd in initrd. The unit options such as {option}`boot.initrd.systemd.services` are the same as their stage 2 counterparts such as {option}`systemd.services`, @@ -140,7 +140,7 @@ in { default = ""; type = types.lines; example = "DefaultLimitCORE=infinity"; - description = lib.mdDoc '' + description = '' Extra config options for systemd. See systemd-system.conf(5) man page for available options. ''; @@ -150,14 +150,14 @@ in { type = with types; attrsOf (nullOr (oneOf [ str path package ])); default = {}; example = { SYSTEMD_LOG_LEVEL = "debug"; }; - description = lib.mdDoc '' + description = '' Environment variables of PID 1. These variables are *not* passed to started units. ''; }; contents = mkOption { - description = lib.mdDoc "Set of files that have to be linked into the initrd"; + description = "Set of files that have to be linked into the initrd"; example = literalExpression '' { "/etc/hostname".text = "mymachine"; @@ -168,7 +168,7 @@ in { }; storePaths = mkOption { - description = lib.mdDoc '' + description = '' Store paths to copy into the initrd as well. ''; type = with types; listOf (oneOf [ singleLineStr package ]); @@ -176,7 +176,7 @@ in { }; strip = mkOption { - description = lib.mdDoc '' + description = '' Whether to completely strip executables and libraries copied to the initramfs. Setting this to false may save on the order of 30MiB on the @@ -189,7 +189,7 @@ in { }; extraBin = mkOption { - description = lib.mdDoc '' + description = '' Tools to add to /bin ''; example = literalExpression '' @@ -202,7 +202,7 @@ in { }; suppressedStorePaths = mkOption { - description = lib.mdDoc '' + description = '' Store paths specified in the storePaths option that should not be copied. ''; @@ -225,7 +225,7 @@ in { emergencyAccess = mkOption { type = with types; oneOf [ bool (nullOr (passwdEntry str)) ]; - description = lib.mdDoc '' + description = '' Set to true for unauthenticated emergency access, and false for no emergency access. @@ -238,7 +238,7 @@ in { initrdBin = mkOption { type = types.listOf types.package; default = []; - description = lib.mdDoc '' + description = '' Packages to include in /bin for the stage 1 emergency shell. ''; }; @@ -247,7 +247,7 @@ in { default = [ ]; type = types.listOf types.str; example = [ "debug-shell.service" "systemd-quotacheck.service" ]; - description = lib.mdDoc '' + description = '' Additional units shipped with systemd that shall be enabled. ''; }; @@ -256,7 +256,7 @@ in { default = [ ]; type = types.listOf types.str; example = [ "systemd-backlight@.service" ]; - description = lib.mdDoc '' + description = '' A list of units to skip when generating system systemd configuration directory. This has priority over upstream units, {option}`boot.initrd.systemd.units`, and {option}`boot.initrd.systemd.additionalUpstreamUnits`. The main purpose of this is to @@ -266,7 +266,7 @@ in { }; units = mkOption { - description = lib.mdDoc "Definition of systemd units."; + description = "Definition of systemd units."; default = {}; visible = "shallow"; type = systemdUtils.types.units; @@ -276,49 +276,49 @@ in { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]"; - description = lib.mdDoc "Packages providing systemd units and hooks."; + description = "Packages providing systemd units and hooks."; }; targets = mkOption { default = {}; visible = "shallow"; type = systemdUtils.types.initrdTargets; - description = lib.mdDoc "Definition of systemd target units."; + description = "Definition of systemd target units."; }; services = mkOption { default = {}; type = systemdUtils.types.initrdServices; visible = "shallow"; - description = lib.mdDoc "Definition of systemd service units."; + description = "Definition of systemd service units."; }; sockets = mkOption { default = {}; type = systemdUtils.types.initrdSockets; visible = "shallow"; - description = lib.mdDoc "Definition of systemd socket units."; + description = "Definition of systemd socket units."; }; timers = mkOption { default = {}; type = systemdUtils.types.initrdTimers; visible = "shallow"; - description = lib.mdDoc "Definition of systemd timer units."; + description = "Definition of systemd timer units."; }; paths = mkOption { default = {}; type = systemdUtils.types.initrdPaths; visible = "shallow"; - description = lib.mdDoc "Definition of systemd path units."; + description = "Definition of systemd path units."; }; mounts = mkOption { default = []; type = systemdUtils.types.initrdMounts; visible = "shallow"; - description = lib.mdDoc '' + description = '' Definition of systemd mount units. This is a list instead of an attrSet, because systemd mandates the names to be derived from the 'where' attribute. @@ -329,7 +329,7 @@ in { default = []; type = systemdUtils.types.automounts; visible = "shallow"; - description = lib.mdDoc '' + description = '' Definition of systemd automount units. This is a list instead of an attrSet, because systemd mandates the names to be derived from the 'where' attribute. @@ -340,13 +340,13 @@ in { default = {}; type = systemdUtils.types.slices; visible = "shallow"; - description = lib.mdDoc "Definition of slice configurations."; + description = "Definition of slice configurations."; }; enableTpm2 = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to enable TPM2 support in the initrd. ''; }; diff --git a/nixos/modules/system/boot/systemd/journald-gateway.nix b/nixos/modules/system/boot/systemd/journald-gateway.nix index 854965282344d..1bcb3f400c619 100644 --- a/nixos/modules/system/boot/systemd/journald-gateway.nix +++ b/nixos/modules/system/boot/systemd/journald-gateway.nix @@ -24,7 +24,7 @@ in cert = lib.mkOption { default = null; type = with lib.types; nullOr str; - description = lib.mdDoc '' + description = '' The path to a file or `AF_UNIX` stream socket to read the server certificate from. @@ -37,7 +37,7 @@ in key = lib.mkOption { default = null; type = with lib.types; nullOr str; - description = lib.mdDoc '' + description = '' Specify the path to a file or `AF_UNIX` stream socket to read the secret server key corresponding to the certificate specified with {option}`services.journald.gateway.cert` from. @@ -52,7 +52,7 @@ in trust = lib.mkOption { default = null; type = with lib.types; nullOr str; - description = lib.mdDoc '' + description = '' Specify the path to a file or `AF_UNIX` stream socket to read a CA certificate from. @@ -65,7 +65,7 @@ in system = lib.mkOption { default = true; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Serve entries from system services and the kernel. This has the same meaning as `--system` for {manpage}`journalctl(1)`. @@ -75,7 +75,7 @@ in user = lib.mkOption { default = true; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Serve entries from services for the current user. This has the same meaning as `--user` for {manpage}`journalctl(1)`. @@ -85,7 +85,7 @@ in merge = lib.mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Serve entries interleaved from all available journals, including other machines. diff --git a/nixos/modules/system/boot/systemd/journald-remote.nix b/nixos/modules/system/boot/systemd/journald-remote.nix index 57a0a133e1c6d..13674694c144e 100644 --- a/nixos/modules/system/boot/systemd/journald-remote.nix +++ b/nixos/modules/system/boot/systemd/journald-remote.nix @@ -18,7 +18,7 @@ in listen = lib.mkOption { default = "https"; type = lib.types.enum [ "https" "http" ]; - description = lib.mdDoc '' + description = '' Which protocol to listen to. ''; }; @@ -26,7 +26,7 @@ in output = lib.mkOption { default = "/var/log/journal/remote/"; type = lib.types.str; - description = lib.mdDoc '' + description = '' The location of the output journal. In case the output file is not specified, journal files will be created @@ -52,7 +52,7 @@ in settings = lib.mkOption { default = { }; - description = lib.mdDoc '' + description = '' Configuration in the journal-remote configuration file. See {manpage}`journal-remote.conf(5)` for available options. ''; @@ -75,7 +75,7 @@ in default = "host"; example = "none"; type = lib.types.enum [ "host" "none" ]; - description = lib.mdDoc '' + description = '' With "host", a separate output file is used, based on the hostname of the other endpoint of a connection. With "none", only one output journal file is used. @@ -85,7 +85,7 @@ in ServerKeyFile = lib.mkOption { default = "/etc/ssl/private/journal-remote.pem"; type = lib.types.str; - description = lib.mdDoc '' + description = '' A path to a SSL secret key file in PEM format. Note that due to security reasons, `systemd-journal-remote` will @@ -101,7 +101,7 @@ in ServerCertificateFile = lib.mkOption { default = "/etc/ssl/certs/journal-remote.pem"; type = lib.types.str; - description = lib.mdDoc '' + description = '' A path to a SSL certificate file in PEM format. This option can be used with `listen = "https"`. If the path @@ -113,7 +113,7 @@ in TrustedCertificateFile = lib.mkOption { default = "/etc/ssl/ca/trusted.pem"; type = lib.types.str; - description = lib.mdDoc '' + description = '' A path to a SSL CA certificate file in PEM format, or `all`. If `all` is set, then client certificate checking will be diff --git a/nixos/modules/system/boot/systemd/journald-upload.nix b/nixos/modules/system/boot/systemd/journald-upload.nix index 6421e5fa486f9..053f886ff5c6b 100644 --- a/nixos/modules/system/boot/systemd/journald-upload.nix +++ b/nixos/modules/system/boot/systemd/journald-upload.nix @@ -12,7 +12,7 @@ in settings = lib.mkOption { default = { }; - description = lib.mdDoc '' + description = '' Configuration for journal-upload. See {manpage}`journal-upload.conf(5)` for available options. ''; diff --git a/nixos/modules/system/boot/systemd/journald.nix b/nixos/modules/system/boot/systemd/journald.nix index 62e24a305ddeb..f9f05d2b08f41 100644 --- a/nixos/modules/system/boot/systemd/journald.nix +++ b/nixos/modules/system/boot/systemd/journald.nix @@ -13,13 +13,13 @@ in { services.journald.console = mkOption { default = ""; type = types.str; - description = lib.mdDoc "If non-empty, write log messages to the specified TTY device."; + description = "If non-empty, write log messages to the specified TTY device."; }; services.journald.rateLimitInterval = mkOption { default = "30s"; type = types.str; - description = lib.mdDoc '' + description = '' Configures the rate limiting interval that is applied to all messages generated on the system. This rate limiting is applied per-service, so that two services which log do not interfere with @@ -35,7 +35,7 @@ in { services.journald.storage = mkOption { default = "persistent"; type = types.enum [ "persistent" "volatile" "auto" "none" ]; - description = mdDoc '' + description = '' Controls where to store journal data. See {manpage}`journald.conf(5)` for further information. ''; @@ -44,7 +44,7 @@ in { services.journald.rateLimitBurst = mkOption { default = 10000; type = types.int; - description = lib.mdDoc '' + description = '' Configures the rate limiting burst limit (number of messages per interval) that is applied to all messages generated on the system. This rate limiting is applied per-service, so that two services @@ -71,7 +71,7 @@ in { default = ""; type = types.lines; example = "Storage=volatile"; - description = lib.mdDoc '' + description = '' Extra config options for systemd-journald. See man journald.conf for available options. ''; @@ -81,7 +81,7 @@ in { default = config.services.rsyslogd.enable || config.services.syslog-ng.enable; defaultText = literalExpression "services.rsyslogd.enable || services.syslog-ng.enable"; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to forward log messages to syslog. ''; }; diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index cf01c18828573..ed5369c09ccb2 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -16,7 +16,7 @@ in default = ""; type = types.lines; example = "IdleAction=lock"; - description = lib.mdDoc '' + description = '' Extra config options for systemd-logind. See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html) for available options. @@ -26,7 +26,7 @@ in killUserProcesses = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Specifies whether the processes of a user should be killed when the user logs out. If true, the scope unit corresponding to the session and all processes inside that scope will be @@ -44,7 +44,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the power key is pressed. ''; }; @@ -54,7 +54,7 @@ in example = "reboot"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the power key is long-pressed. ''; }; @@ -64,7 +64,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the reboot key is pressed. ''; }; @@ -74,7 +74,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the reboot key is long-pressed. ''; }; @@ -84,7 +84,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the suspend key is pressed. ''; }; @@ -94,7 +94,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the suspend key is long-pressed. ''; }; @@ -104,7 +104,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the hibernate key is pressed. ''; }; @@ -114,7 +114,7 @@ in example = "suspend"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the hibernate key is long-pressed. ''; }; @@ -124,7 +124,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the laptop lid is closed. ''; }; @@ -135,7 +135,7 @@ in example = "ignore"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the laptop lid is closed and the system is on external power. By default use the same action as specified in services.logind.lidSwitch. @@ -147,7 +147,7 @@ in example = "suspend"; type = logindHandlerType; - description = lib.mdDoc '' + description = '' Specifies what to do when the laptop lid is closed and another screen is added. ''; diff --git a/nixos/modules/system/boot/systemd/nspawn.nix b/nixos/modules/system/boot/systemd/nspawn.nix index b513aa051f283..11fbb88838e10 100644 --- a/nixos/modules/system/boot/systemd/nspawn.nix +++ b/nixos/modules/system/boot/systemd/nspawn.nix @@ -52,7 +52,7 @@ let default = {}; example = { Parameters = "/bin/sh"; }; type = types.addCheck (types.attrsOf unitOption) checkExec; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Exec]` section of this unit. See {manpage}`systemd.nspawn(5)` for details. @@ -63,7 +63,7 @@ let default = {}; example = { Bind = [ "/home/alice" ]; }; type = types.addCheck (types.attrsOf unitOption) checkFiles; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Files]` section of this unit. See {manpage}`systemd.nspawn(5)` for details. @@ -74,7 +74,7 @@ let default = {}; example = { Private = false; }; type = types.addCheck (types.attrsOf unitOption) checkNetwork; - description = lib.mdDoc '' + description = '' Each attribute in this set specifies an option in the `[Network]` section of this unit. See {manpage}`systemd.nspawn(5)` for details. @@ -106,7 +106,7 @@ in { systemd.nspawn = mkOption { default = {}; type = with types; attrsOf (submodule instanceOptions); - description = lib.mdDoc "Definition of systemd-nspawn configurations."; + description = "Definition of systemd-nspawn configurations."; }; }; diff --git a/nixos/modules/system/boot/systemd/oomd.nix b/nixos/modules/system/boot/systemd/oomd.nix index edc25784367a4..a2a90e0ceb873 100644 --- a/nixos/modules/system/boot/systemd/oomd.nix +++ b/nixos/modules/system/boot/systemd/oomd.nix @@ -8,19 +8,19 @@ in { ]; options.systemd.oomd = { - enable = lib.mkEnableOption (lib.mdDoc "the `systemd-oomd` OOM killer") // { default = true; }; + enable = lib.mkEnableOption "the `systemd-oomd` OOM killer" // { default = true; }; # Fedora enables the first and third option by default. See the 10-oomd-* files here: # https://src.fedoraproject.org/rpms/systemd/tree/806c95e1c70af18f81d499b24cd7acfa4c36ffd6 - enableRootSlice = lib.mkEnableOption (lib.mdDoc "oomd on the root slice (`-.slice`)"); - enableSystemSlice = lib.mkEnableOption (lib.mdDoc "oomd on the system slice (`system.slice`)"); - enableUserSlices = lib.mkEnableOption (lib.mdDoc "oomd on all user slices (`user@.slice`) and all user owned slices"); + enableRootSlice = lib.mkEnableOption "oomd on the root slice (`-.slice`)"; + enableSystemSlice = lib.mkEnableOption "oomd on the system slice (`system.slice`)"; + enableUserSlices = lib.mkEnableOption "oomd on all user slices (`user@.slice`) and all user owned slices"; extraConfig = lib.mkOption { type = with lib.types; attrsOf (oneOf [ str int bool ]); default = {}; example = lib.literalExpression ''{ DefaultMemoryPressureDurationSec = "20s"; }''; - description = lib.mdDoc '' + description = '' Extra config options for `systemd-oomd`. See {command}`man oomd.conf` for available options. ''; diff --git a/nixos/modules/system/boot/systemd/repart.nix b/nixos/modules/system/boot/systemd/repart.nix index 7771f5fe06789..49db1305bb2b6 100644 --- a/nixos/modules/system/boot/systemd/repart.nix +++ b/nixos/modules/system/boot/systemd/repart.nix @@ -28,8 +28,8 @@ in { options = { boot.initrd.systemd.repart = { - enable = lib.mkEnableOption (lib.mdDoc "systemd-repart") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "systemd-repart" // { + description = '' Grow and add partitions to a partition table at boot time in the initrd. systemd-repart only works with GPT partition tables. @@ -40,7 +40,7 @@ in device = lib.mkOption { type = with lib.types; nullOr str; - description = lib.mdDoc '' + description = '' The device to operate on. If `device == null`, systemd-repart will operate on the device @@ -53,8 +53,8 @@ in }; systemd.repart = { - enable = lib.mkEnableOption (lib.mdDoc "systemd-repart") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "systemd-repart" // { + description = '' Grow and add partitions to a partition table. systemd-repart only works with GPT partition tables. @@ -76,7 +76,7 @@ in SizeMaxBytes = "2G"; }; }; - description = lib.mdDoc '' + description = '' Specify partitions as a set of the names of the definition files as the key and the partition configuration as its value. The partition configuration can use all upstream options. See <link diff --git a/nixos/modules/system/boot/systemd/shutdown.nix b/nixos/modules/system/boot/systemd/shutdown.nix index d7300e940af20..5c2525a57b4be 100644 --- a/nixos/modules/system/boot/systemd/shutdown.nix +++ b/nixos/modules/system/boot/systemd/shutdown.nix @@ -9,9 +9,9 @@ in { options.systemd.shutdownRamfs = { - enable = lib.mkEnableOption (lib.mdDoc "pivoting back to an initramfs for shutdown") // { default = true; }; + enable = lib.mkEnableOption "pivoting back to an initramfs for shutdown" // { default = true; }; contents = lib.mkOption { - description = lib.mdDoc "Set of files that have to be linked into the shutdown ramfs"; + description = "Set of files that have to be linked into the shutdown ramfs"; example = lib.literalExpression '' { "/lib/systemd/system-shutdown/zpool-sync-shutdown".source = writeShellScript "zpool" "exec ''${zfs}/bin/zpool sync" @@ -21,7 +21,7 @@ in { }; storePaths = lib.mkOption { - description = lib.mdDoc '' + description = '' Store paths to copy into the shutdown ramfs as well. ''; type = lib.types.listOf lib.types.singleLineStr; diff --git a/nixos/modules/system/boot/systemd/sysupdate.nix b/nixos/modules/system/boot/systemd/sysupdate.nix index 1f4088ddf8251..67f0b3b1caadc 100644 --- a/nixos/modules/system/boot/systemd/sysupdate.nix +++ b/nixos/modules/system/boot/systemd/sysupdate.nix @@ -13,8 +13,8 @@ in { options.systemd.sysupdate = { - enable = lib.mkEnableOption (lib.mdDoc "systemd-sysupdate") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "systemd-sysupdate" // { + description = '' Atomically update the host OS, container images, portable service images or other sources. @@ -29,7 +29,7 @@ in timerConfig = utils.systemdUtils.unitOptions.timerOptions.options.timerConfig // { default = { }; - description = lib.mdDoc '' + description = '' The timer configuration for performing the update. By default, the upstream configuration is used: @@ -38,8 +38,8 @@ in }; reboot = { - enable = lib.mkEnableOption (lib.mdDoc "automatically rebooting after an update") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "automatically rebooting after an update" // { + description = '' Whether to automatically reboot after an update. If set to `true`, the system will automatically reboot via a @@ -58,7 +58,7 @@ in timerConfig = utils.systemdUtils.unitOptions.timerOptions.options.timerConfig // { default = { }; - description = lib.mdDoc '' + description = '' The timer configuration for rebooting after an update. By default, the upstream configuration is used: @@ -98,7 +98,7 @@ in }; }; }; - description = lib.mdDoc '' + description = '' Specify transfers as a set of the names of the transfer files as the key and the configuration as its value. The configuration can use all upstream options. See diff --git a/nixos/modules/system/boot/systemd/sysusers.nix b/nixos/modules/system/boot/systemd/sysusers.nix index c619c2d91eb09..de70009705973 100644 --- a/nixos/modules/system/boot/systemd/sysusers.nix +++ b/nixos/modules/system/boot/systemd/sysusers.nix @@ -67,8 +67,8 @@ in # users-groups.nix systemd.sysusers = { - enable = lib.mkEnableOption (lib.mdDoc "systemd-sysusers") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "systemd-sysusers" // { + description = '' If enabled, users are created with systemd-sysusers instead of with the custom `update-users-groups.pl` script. diff --git a/nixos/modules/system/boot/systemd/tmpfiles.nix b/nixos/modules/system/boot/systemd/tmpfiles.nix index dae23eddd1e2b..ded13728017d1 100644 --- a/nixos/modules/system/boot/systemd/tmpfiles.nix +++ b/nixos/modules/system/boot/systemd/tmpfiles.nix @@ -12,7 +12,7 @@ in type = types.listOf types.str; default = []; example = [ "d /tmp 1777 root root 10d" ]; - description = lib.mdDoc '' + description = '' Rules for creation, deletion and cleaning of volatile and temporary files automatically. See {manpage}`tmpfiles.d(5)` @@ -21,7 +21,7 @@ in }; systemd.tmpfiles.settings = mkOption { - description = lib.mdDoc '' + description = '' Declare systemd-tmpfiles rules to create, delete, and clean up volatile and temporary files and directories. @@ -43,7 +43,7 @@ in type = types.str; default = name; example = "d"; - description = lib.mdDoc '' + description = '' The type of operation to perform on the file. The type consists of a single letter and optionally one or more @@ -58,7 +58,7 @@ in type = types.str; default = "-"; example = "0755"; - description = lib.mdDoc '' + description = '' The file access mode to use when creating this file or directory. ''; }; @@ -66,7 +66,7 @@ in type = types.str; default = "-"; example = "root"; - description = lib.mdDoc '' + description = '' The user of the file. This may either be a numeric ID or a user/group name. @@ -79,7 +79,7 @@ in type = types.str; default = "-"; example = "root"; - description = lib.mdDoc '' + description = '' The group of the file. This may either be a numeric ID or a user/group name. @@ -92,7 +92,7 @@ in type = types.str; default = "-"; example = "10d"; - description = lib.mdDoc '' + description = '' Delete a file when it reaches a certain age. If a file or directory is older than the current time minus the age @@ -105,7 +105,7 @@ in type = types.str; default = ""; example = ""; - description = lib.mdDoc '' + description = '' An argument whose meaning depends on the type of operation. Please see the upstream documentation for the meaning of this @@ -121,7 +121,7 @@ in default = []; example = literalExpression "[ pkgs.lvm2 ]"; apply = map getLib; - description = lib.mdDoc '' + description = '' List of packages containing {command}`systemd-tmpfiles` rules. All files ending in .conf found in diff --git a/nixos/modules/system/boot/systemd/user.nix b/nixos/modules/system/boot/systemd/user.nix index 64dc19633eca9..4c7b51ee22b74 100644 --- a/nixos/modules/system/boot/systemd/user.nix +++ b/nixos/modules/system/boot/systemd/user.nix @@ -59,14 +59,14 @@ in { default = ""; type = types.lines; example = "DefaultCPUAccounting=yes"; - description = lib.mdDoc '' + description = '' Extra config options for systemd user instances. See {manpage}`systemd-user.conf(5)` for available options. ''; }; systemd.user.units = mkOption { - description = lib.mdDoc "Definition of systemd per-user units."; + description = "Definition of systemd per-user units."; default = {}; type = systemdUtils.types.units; }; @@ -74,37 +74,37 @@ in { systemd.user.paths = mkOption { default = {}; type = systemdUtils.types.paths; - description = lib.mdDoc "Definition of systemd per-user path units."; + description = "Definition of systemd per-user path units."; }; systemd.user.services = mkOption { default = {}; type = systemdUtils.types.services; - description = lib.mdDoc "Definition of systemd per-user service units."; + description = "Definition of systemd per-user service units."; }; systemd.user.slices = mkOption { default = {}; type = systemdUtils.types.slices; - description = lib.mdDoc "Definition of systemd per-user slice units."; + description = "Definition of systemd per-user slice units."; }; systemd.user.sockets = mkOption { default = {}; type = systemdUtils.types.sockets; - description = lib.mdDoc "Definition of systemd per-user socket units."; + description = "Definition of systemd per-user socket units."; }; systemd.user.targets = mkOption { default = {}; type = systemdUtils.types.targets; - description = lib.mdDoc "Definition of systemd per-user target units."; + description = "Definition of systemd per-user target units."; }; systemd.user.timers = mkOption { default = {}; type = systemdUtils.types.timers; - description = lib.mdDoc "Definition of systemd per-user timer units."; + description = "Definition of systemd per-user timer units."; }; systemd.user.tmpfiles = { @@ -112,7 +112,7 @@ in { type = types.listOf types.str; default = []; example = [ "D %C - - - 7d" ]; - description = lib.mdDoc '' + description = '' Global user rules for creation, deletion and cleaning of volatile and temporary files automatically. See {manpage}`tmpfiles.d(5)` @@ -121,7 +121,7 @@ in { }; users = mkOption { - description = mdDoc '' + description = '' Per-user rules for creation, deletion and cleaning of volatile and temporary files automatically. ''; @@ -132,7 +132,7 @@ in { type = types.listOf types.str; default = []; example = [ "D %C - - - 7d" ]; - description = mdDoc '' + description = '' Per-user rules for creation, deletion and cleaning of volatile and temporary files automatically. See {manpage}`tmpfiles.d(5)` @@ -148,7 +148,7 @@ in { default = []; type = types.listOf types.str; example = []; - description = lib.mdDoc '' + description = '' Additional units shipped with systemd that should be enabled for per-user systemd instances. ''; internal = true; diff --git a/nixos/modules/system/boot/systemd/userdbd.nix b/nixos/modules/system/boot/systemd/userdbd.nix index e7f6d42341c4e..0161a7c2c6815 100644 --- a/nixos/modules/system/boot/systemd/userdbd.nix +++ b/nixos/modules/system/boot/systemd/userdbd.nix @@ -4,9 +4,9 @@ let cfg = config.services.userdbd; in { - options.services.userdbd.enable = lib.mkEnableOption (lib.mdDoc '' + options.services.userdbd.enable = lib.mkEnableOption '' the systemd JSON user/group record lookup service - ''); + ''; config = lib.mkIf cfg.enable { systemd.additionalUpstreamSystemUnits = [ "systemd-userdbd.socket" diff --git a/nixos/modules/system/boot/timesyncd.nix b/nixos/modules/system/boot/timesyncd.nix index ef17c1481abb4..f93064569bf68 100644 --- a/nixos/modules/system/boot/timesyncd.nix +++ b/nixos/modules/system/boot/timesyncd.nix @@ -11,7 +11,7 @@ with lib; default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; type = types.bool; - description = lib.mdDoc '' + description = '' Enables the systemd NTP client daemon. ''; }; @@ -19,7 +19,7 @@ with lib; default = config.networking.timeServers; defaultText = literalExpression "config.networking.timeServers"; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' The set of NTP servers from which to synchronise. Note if this is set to an empty list, the defaults systemd itself is compiled with ({0..4}.nixos.pool.ntp.org) apply, @@ -32,7 +32,7 @@ with lib; example = '' PollIntervalMaxSec=180 ''; - description = lib.mdDoc '' + description = '' Extra config options for systemd-timesyncd. See [ timesyncd.conf(5)](https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html) for available options. diff --git a/nixos/modules/system/boot/tmp.nix b/nixos/modules/system/boot/tmp.nix index fd16cd3fba429..150f4adaf3ee6 100644 --- a/nixos/modules/system/boot/tmp.nix +++ b/nixos/modules/system/boot/tmp.nix @@ -17,7 +17,7 @@ in cleanOnBoot = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to delete all files in {file}`/tmp` during boot. ''; }; @@ -25,7 +25,7 @@ in tmpfsSize = mkOption { type = types.oneOf [ types.str types.types.ints.positive ]; default = "50%"; - description = lib.mdDoc '' + description = '' Size of tmpfs in percentage. Percentage is defined by systemd. ''; @@ -34,7 +34,7 @@ in useTmpfs = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to mount a tmpfs on {file}`/tmp` during boot. ::: {.note} diff --git a/nixos/modules/system/boot/uki.nix b/nixos/modules/system/boot/uki.nix index c8d3c2f6605f5..c86439e98a3cf 100644 --- a/nixos/modules/system/boot/uki.nix +++ b/nixos/modules/system/boot/uki.nix @@ -15,20 +15,20 @@ in boot.uki = { name = lib.mkOption { type = lib.types.str; - description = lib.mdDoc "Name of the UKI"; + description = "Name of the UKI"; }; version = lib.mkOption { type = lib.types.nullOr lib.types.str; default = config.system.image.version; defaultText = lib.literalExpression "config.system.image.version"; - description = lib.mdDoc "Version of the image or generation the UKI belongs to"; + description = "Version of the image or generation the UKI belongs to"; }; tries = lib.mkOption { type = lib.types.nullOr lib.types.ints.unsigned; default = null; - description = lib.mdDoc '' + description = '' Number of boot attempts before this UKI is considered bad. If no tries are specified (the default) automatic boot assessment remains inactive. @@ -41,7 +41,7 @@ in settings = lib.mkOption { type = format.type; - description = lib.mdDoc '' + description = '' The configuration settings for ukify. These control what the UKI contains and how it is built. ''; @@ -49,7 +49,7 @@ in configFile = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' The configuration file passed to {manpage}`ukify(1)` to create the UKI. By default this configuration file is created from {option}`boot.uki.settings`. @@ -60,7 +60,7 @@ in system.boot.loader.ukiFile = lib.mkOption { type = lib.types.str; internal = true; - description = lib.mdDoc "Name of the UKI file"; + description = "Name of the UKI file"; }; }; diff --git a/nixos/modules/system/boot/unl0kr.nix b/nixos/modules/system/boot/unl0kr.nix index 8d9af37382e01..f5ce693c2de41 100644 --- a/nixos/modules/system/boot/unl0kr.nix +++ b/nixos/modules/system/boot/unl0kr.nix @@ -5,8 +5,8 @@ let in { options.boot.initrd.unl0kr = { - enable = lib.mkEnableOption (lib.mdDoc "unl0kr in initrd") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "unl0kr in initrd" // { + description = '' Whether to enable the unl0kr on-screen keyboard in initrd to unlock LUKS. ''; }; diff --git a/nixos/modules/system/boot/uvesafb.nix b/nixos/modules/system/boot/uvesafb.nix index b10dc42887a15..8da86466a5be8 100644 --- a/nixos/modules/system/boot/uvesafb.nix +++ b/nixos/modules/system/boot/uvesafb.nix @@ -1,21 +1,21 @@ { config, lib, pkgs, ... }: let cfg = config.boot.uvesafb; - inherit (lib) mkIf mkEnableOption mkOption mdDoc types; + inherit (lib) mkIf mkEnableOption mkOption types; in { options = { boot.uvesafb = { - enable = mkEnableOption (mdDoc "uvesafb"); + enable = mkEnableOption "uvesafb"; gfx-mode = mkOption { type = types.str; default = "1024x768-32"; - description = mdDoc "Screen resolution in modedb format. See [uvesafb](https://docs.kernel.org/fb/uvesafb.html) and [modedb](https://docs.kernel.org/fb/modedb.html) documentation for more details. The default value is a sensible default but may be not ideal for all setups."; + description = "Screen resolution in modedb format. See [uvesafb](https://docs.kernel.org/fb/uvesafb.html) and [modedb](https://docs.kernel.org/fb/modedb.html) documentation for more details. The default value is a sensible default but may be not ideal for all setups."; }; v86d.package = mkOption { type = types.package; - description = mdDoc "Which v86d package to use with uvesafb"; + description = "Which v86d package to use with uvesafb"; defaultText = ''config.boot.kernelPackages.v86d.overrideAttrs (old: { hardeningDisable = [ "all" ]; })''; diff --git a/nixos/modules/system/build.nix b/nixos/modules/system/build.nix index 41c0258a5a35c..58dc3f0d41134 100644 --- a/nixos/modules/system/build.nix +++ b/nixos/modules/system/build.nix @@ -7,7 +7,7 @@ in system.build = mkOption { default = {}; - description = lib.mdDoc '' + description = '' Attribute set of derivations used to set up the system. ''; type = types.submoduleWith { diff --git a/nixos/modules/system/etc/etc.nix b/nixos/modules/system/etc/etc.nix index 9f735364196c6..9fded1e1c9742 100644 --- a/nixos/modules/system/etc/etc.nix +++ b/nixos/modules/system/etc/etc.nix @@ -86,7 +86,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Mount `/etc` as an overlayfs instead of generating it via a perl script. Note: This is currently experimental. Only enable this option if you're @@ -97,7 +97,7 @@ in mutable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to mount `/etc` mutably (i.e. read-write) or immutably (i.e. read-only). If this is false, only the immutable lowerdir is mounted. If it is @@ -116,7 +116,7 @@ in "default/useradd".text = "GROUP=100 ..."; } ''; - description = lib.mdDoc '' + description = '' Set of files that have to be linked in {file}`/etc`. ''; @@ -127,7 +127,7 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether this /etc file should be generated. This option allows specific /etc files to be disabled. ''; @@ -135,7 +135,7 @@ in target = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Name of symlink (relative to {file}`/etc`). Defaults to the attribute name. @@ -145,19 +145,19 @@ in text = mkOption { default = null; type = types.nullOr types.lines; - description = lib.mdDoc "Text of the file."; + description = "Text of the file."; }; source = mkOption { type = types.path; - description = lib.mdDoc "Path of the source file."; + description = "Path of the source file."; }; mode = mkOption { type = types.str; default = "symlink"; example = "0600"; - description = lib.mdDoc '' + description = '' If set to something else than `symlink`, the file is copied instead of symlinked, with the given file mode. @@ -167,7 +167,7 @@ in uid = mkOption { default = 0; type = types.int; - description = lib.mdDoc '' + description = '' UID of created file. Only takes effect when the file is copied (that is, the mode is not 'symlink'). ''; @@ -176,7 +176,7 @@ in gid = mkOption { default = 0; type = types.int; - description = lib.mdDoc '' + description = '' GID of created file. Only takes effect when the file is copied (that is, the mode is not 'symlink'). ''; @@ -185,7 +185,7 @@ in user = mkOption { default = "+${toString config.uid}"; type = types.str; - description = lib.mdDoc '' + description = '' User name of created file. Only takes effect when the file is copied (that is, the mode is not 'symlink'). Changing this option takes precedence over `uid`. @@ -195,7 +195,7 @@ in group = mkOption { default = "+${toString config.gid}"; type = types.str; - description = lib.mdDoc '' + description = '' Group name of created file. Only takes effect when the file is copied (that is, the mode is not 'symlink'). Changing this option takes precedence over `gid`. |