diff options
Diffstat (limited to 'nixos/modules/virtualisation')
23 files changed, 116 insertions, 116 deletions
diff --git a/nixos/modules/virtualisation/amazon-init.nix b/nixos/modules/virtualisation/amazon-init.nix index 9c2adb90bfd..8b98f2e32dd 100644 --- a/nixos/modules/virtualisation/amazon-init.nix +++ b/nixos/modules/virtualisation/amazon-init.nix @@ -60,7 +60,7 @@ in { enable = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Enable or disable the amazon-init service. ''; }; diff --git a/nixos/modules/virtualisation/amazon-options.nix b/nixos/modules/virtualisation/amazon-options.nix index 0465571ca92..52c960d453d 100644 --- a/nixos/modules/virtualisation/amazon-options.nix +++ b/nixos/modules/virtualisation/amazon-options.nix @@ -27,13 +27,13 @@ in { type = types.attrsOf (types.submodule { options = { mount = lib.mkOption { - description = "Where to mount this dataset."; + description = lib.mdDoc "Where to mount this dataset."; type = types.nullOr types.string; default = null; }; properties = lib.mkOption { - description = "Properties to set on this dataset."; + description = lib.mdDoc "Properties to set on this dataset."; type = types.attrsOf types.string; default = {}; }; diff --git a/nixos/modules/virtualisation/appvm.nix b/nixos/modules/virtualisation/appvm.nix index 24315a85d0e..b23b321095c 100644 --- a/nixos/modules/virtualisation/appvm.nix +++ b/nixos/modules/virtualisation/appvm.nix @@ -13,13 +13,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This enables AppVMs and related virtualisation settings. ''; }; user = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' AppVM user login. Currenly only AppVMs are supported for a single user only. ''; }; diff --git a/nixos/modules/virtualisation/containerd.nix b/nixos/modules/virtualisation/containerd.nix index ea89a994b17..96fa6761296 100644 --- a/nixos/modules/virtualisation/containerd.nix +++ b/nixos/modules/virtualisation/containerd.nix @@ -23,7 +23,7 @@ in configFile = lib.mkOption { default = null; - description = '' + description = lib.mdDoc '' Path to containerd config file. Setting this option will override any configuration applied by the settings option. ''; @@ -33,14 +33,14 @@ in settings = lib.mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Verbatim lines to add to containerd.toml ''; }; args = lib.mkOption { default = {}; - description = "extra args to append to the containerd cmdline"; + description = lib.mdDoc "extra args to append to the containerd cmdline"; type = attrsOf str; }; }; diff --git a/nixos/modules/virtualisation/cri-o.nix b/nixos/modules/virtualisation/cri-o.nix index 38766113f39..3c9b0a061d2 100644 --- a/nixos/modules/virtualisation/cri-o.nix +++ b/nixos/modules/virtualisation/cri-o.nix @@ -25,33 +25,33 @@ in storageDriver = mkOption { type = types.enum [ "btrfs" "overlay" "vfs" ]; default = "overlay"; - description = "Storage driver to be used"; + description = lib.mdDoc "Storage driver to be used"; }; logLevel = mkOption { type = types.enum [ "trace" "debug" "info" "warn" "error" "fatal" ]; default = "info"; - description = "Log level to be used"; + description = lib.mdDoc "Log level to be used"; }; pauseImage = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default pause image for pod sandboxes"; + description = lib.mdDoc "Override the default pause image for pod sandboxes"; example = "k8s.gcr.io/pause:3.2"; }; pauseCommand = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default pause command"; + description = lib.mdDoc "Override the default pause command"; example = "/pause"; }; runtime = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default runtime"; + description = lib.mdDoc "Override the default runtime"; example = "crun"; }; @@ -63,7 +63,7 @@ in pkgs.gvisor ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed in the CRI-O wrapper. ''; }; @@ -87,9 +87,9 @@ in settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Configuration for cri-o, see - <link xlink:href="https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md"/>. + <https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md>. ''; }; }; diff --git a/nixos/modules/virtualisation/digital-ocean-config.nix b/nixos/modules/virtualisation/digital-ocean-config.nix index 88cb0cd450e..754bc1a5185 100644 --- a/nixos/modules/virtualisation/digital-ocean-config.nix +++ b/nixos/modules/virtualisation/digital-ocean-config.nix @@ -10,19 +10,19 @@ with lib; type = bool; default = false; example = true; - description = "Whether to set the root password from the Digital Ocean metadata"; + description = lib.mdDoc "Whether to set the root password from the Digital Ocean metadata"; }; setSshKeys = mkOption { type = bool; default = true; example = true; - description = "Whether to fetch ssh keys from Digital Ocean"; + description = lib.mdDoc "Whether to fetch ssh keys from Digital Ocean"; }; seedEntropy = mkOption { type = bool; default = true; example = true; - description = "Whether to run the kernel RNG entropy seeding script from the Digital Ocean vendor data"; + description = lib.mdDoc "Whether to run the kernel RNG entropy seeding script from the Digital Ocean vendor data"; }; }; config = diff --git a/nixos/modules/virtualisation/docker.nix b/nixos/modules/virtualisation/docker.nix index c6eca4d6ed5..062ad7f53cf 100644 --- a/nixos/modules/virtualisation/docker.nix +++ b/nixos/modules/virtualisation/docker.nix @@ -21,11 +21,11 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' This option enables docker, a daemon that manages linux containers. Users in the "docker" group can interact with the daemon (e.g. to start or stop containers) using the - <command>docker</command> command line tool. + {command}`docker` command line tool. ''; }; @@ -34,7 +34,7 @@ in type = types.listOf types.str; default = ["/run/docker.sock"]; description = - '' + lib.mdDoc '' A list of unix and tcp docker should listen to. The format follows ListenStream as described in systemd.socket(5). ''; @@ -45,10 +45,10 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' When enabled dockerd is started on boot. This is required for containers which are created with the - <literal>--restart=always</literal> flag to work. If this option is + `--restart=always` flag to work. If this option is disabled, docker might be started on demand by socket activation. ''; }; @@ -61,7 +61,7 @@ in ipv6 = true; "fixed-cidr-v6" = "fd00::/80"; }; - description = '' + description = lib.mdDoc '' Configuration for docker daemon. The attributes are serialized to JSON used as daemon.conf. See https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file ''; @@ -71,7 +71,7 @@ in mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable nvidia-docker wrapper, supporting NVIDIA GPUs inside docker containers. ''; }; @@ -81,7 +81,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Allow dockerd to be restarted without affecting running container. This option is incompatible with docker swarm. ''; @@ -92,7 +92,7 @@ in type = types.nullOr (types.enum ["aufs" "btrfs" "devicemapper" "overlay" "overlay2" "zfs"]); default = null; description = - '' + lib.mdDoc '' This option determines which Docker storage driver to use. By default it let's docker automatically choose preferred storage driver. ''; @@ -103,7 +103,7 @@ in type = types.enum ["none" "json-file" "syslog" "journald" "gelf" "fluentd" "awslogs" "splunk" "etwlogs" "gcplogs"]; default = "journald"; description = - '' + lib.mdDoc '' This option determines which Docker log driver to use. ''; }; @@ -113,9 +113,9 @@ in type = types.separatedString " "; default = ""; description = - '' + lib.mdDoc '' The extra command-line options to pass to - <command>docker</command> daemon. + {command}`docker` daemon. ''; }; @@ -123,10 +123,10 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to periodically prune Docker resources. If enabled, a - systemd timer will run <literal>docker system prune -f</literal> - as specified by the <literal>dates</literal> option. + systemd timer will run `docker system prune -f` + as specified by the `dates` option. ''; }; @@ -134,8 +134,8 @@ in type = types.listOf types.str; default = []; example = [ "--all" ]; - description = '' - Any additional flags passed to <command>docker system prune</command>. + description = lib.mdDoc '' + Any additional flags passed to {command}`docker system prune`. ''; }; @@ -155,7 +155,7 @@ in default = pkgs.docker; defaultText = literalExpression "pkgs.docker"; type = types.package; - description = '' + description = lib.mdDoc '' Docker package to be used in the module. ''; }; diff --git a/nixos/modules/virtualisation/ecs-agent.nix b/nixos/modules/virtualisation/ecs-agent.nix index aa38a02ea08..af1736fcf0b 100644 --- a/nixos/modules/virtualisation/ecs-agent.nix +++ b/nixos/modules/virtualisation/ecs-agent.nix @@ -10,14 +10,14 @@ in { package = mkOption { type = types.path; - description = "The ECS agent package to use"; + description = lib.mdDoc "The ECS agent package to use"; default = pkgs.ecs-agent; defaultText = literalExpression "pkgs.ecs-agent"; }; extra-environment = mkOption { type = types.attrsOf types.str; - description = "The environment the ECS agent should run with. See the ECS agent documentation for keys that work here."; + description = lib.mdDoc "The environment the ECS agent should run with. See the ECS agent documentation for keys that work here."; default = {}; }; }; diff --git a/nixos/modules/virtualisation/hyperv-guest.nix b/nixos/modules/virtualisation/hyperv-guest.nix index fb6502644b8..e6ba38370f2 100644 --- a/nixos/modules/virtualisation/hyperv-guest.nix +++ b/nixos/modules/virtualisation/hyperv-guest.nix @@ -14,7 +14,7 @@ in { type = types.str; default = "1152x864"; example = "1024x768"; - description = '' + description = lib.mdDoc '' Resolution at which to initialize the video adapter. Supports screen resolution up to Full HD 1920x1080 with 32 bit color diff --git a/nixos/modules/virtualisation/kvmgt.nix b/nixos/modules/virtualisation/kvmgt.nix index 5e7a73bec90..5ea71c3a914 100644 --- a/nixos/modules/virtualisation/kvmgt.nix +++ b/nixos/modules/virtualisation/kvmgt.nix @@ -26,7 +26,7 @@ in { device = mkOption { type = types.str; default = "0000:00:02.0"; - description = "PCI ID of graphics card. You can figure it with <command>ls /sys/class/mdev_bus</command>."; + description = lib.mdDoc "PCI ID of graphics card. You can figure it with {command}`ls /sys/class/mdev_bus`."; }; vgpus = mkOption { default = {}; diff --git a/nixos/modules/virtualisation/libvirtd.nix b/nixos/modules/virtualisation/libvirtd.nix index 31d18ae7344..f7d0ef39c5a 100644 --- a/nixos/modules/virtualisation/libvirtd.nix +++ b/nixos/modules/virtualisation/libvirtd.nix @@ -29,7 +29,7 @@ let enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allows libvirtd to take advantage of OVMF when creating new QEMU VMs with UEFI boot. ''; @@ -47,7 +47,7 @@ let default = [ pkgs.OVMF.fd ]; defaultText = literalExpression "[ pkgs.OVMF.fd ]"; example = literalExpression "[ pkgs.OVMFFull.fd pkgs.pkgsCross.aarch64-multiplatform.OVMF.fd ]"; - description = '' + description = lib.mdDoc '' List of OVMF packages to use. Each listed package must contain files names FV/OVMF_CODE.fd and FV/OVMF_VARS.fd or FV/AAVMF_CODE.fd and FV/AAVMF_VARS.fd ''; }; @@ -59,7 +59,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allows libvirtd to use swtpm to create an emulated TPM. ''; }; @@ -68,7 +68,7 @@ let type = types.package; default = pkgs.swtpm; defaultText = literalExpression "pkgs.swtpm"; - description = '' + description = lib.mdDoc '' swtpm package to use. ''; }; @@ -91,7 +91,7 @@ let runAsRoot = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If true, libvirtd runs qemu as root. If false, libvirtd runs qemu as unprivileged user qemu-libvirtd. Changing this option to false may cause file permission issues @@ -105,7 +105,7 @@ let default = '' namespaces = [] ''; - description = '' + description = lib.mdDoc '' Contents written to the qemu configuration file, qemu.conf. Make sure to include a proper namespace configuration when supplying custom configuration. @@ -115,7 +115,7 @@ let ovmf = mkOption { type = ovmfModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU's OVMF options. ''; }; @@ -123,7 +123,7 @@ let swtpm = mkOption { type = swtpmModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU's swtpm options. ''; }; @@ -162,11 +162,11 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option enables libvirtd, a daemon that manages virtual machines. Users in the "libvirtd" group can interact with the daemon (e.g. to start or stop VMs) using the - <command>virsh</command> command line tool, among others. + {command}`virsh` command line tool, among others. ''; }; @@ -174,7 +174,7 @@ in type = types.package; default = pkgs.libvirt; defaultText = literalExpression "pkgs.libvirt"; - description = '' + description = lib.mdDoc '' libvirt package to use. ''; }; @@ -182,7 +182,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra contents appended to the libvirtd configuration file, libvirtd.conf. ''; @@ -192,7 +192,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "--verbose" ]; - description = '' + description = lib.mdDoc '' Extra command line arguments passed to libvirtd on startup. ''; }; @@ -200,7 +200,7 @@ in onBoot = mkOption { type = types.enum [ "start" "ignore" ]; default = "start"; - description = '' + description = lib.mdDoc '' Specifies the action to be done to / on the guests when the host boots. The "start" option starts all guests that were running prior to shutdown regardless of their autostart settings. The "ignore" option will not @@ -212,7 +212,7 @@ in onShutdown = mkOption { type = types.enum [ "shutdown" "suspend" ]; default = "suspend"; - description = '' + description = lib.mdDoc '' When shutting down / restarting the host what method should be used to gracefully halt the guests. Setting to "shutdown" will cause an ACPI shutdown of each guest. "suspend" will @@ -223,7 +223,7 @@ in allowedBridges = mkOption { type = types.listOf types.str; default = [ "virbr0" ]; - description = '' + description = lib.mdDoc '' List of bridge devices that can be used by qemu:///session ''; }; @@ -231,7 +231,7 @@ in qemu = mkOption { type = qemuModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU related options. ''; }; diff --git a/nixos/modules/virtualisation/lxc.nix b/nixos/modules/virtualisation/lxc.nix index 0f8b22a45df..2b184960daa 100644 --- a/nixos/modules/virtualisation/lxc.nix +++ b/nixos/modules/virtualisation/lxc.nix @@ -19,7 +19,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' This enables Linux Containers (LXC), which provides tools for creating and managing system or application containers on Linux. diff --git a/nixos/modules/virtualisation/lxd.nix b/nixos/modules/virtualisation/lxd.nix index 18451b147ff..f1eabee5ffa 100644 --- a/nixos/modules/virtualisation/lxd.nix +++ b/nixos/modules/virtualisation/lxd.nix @@ -36,7 +36,7 @@ in { type = types.package; default = pkgs.lxd; defaultText = literalExpression "pkgs.lxd"; - description = '' + description = lib.mdDoc '' The LXD package to use. ''; }; @@ -45,7 +45,7 @@ in { type = types.package; default = pkgs.lxc; defaultText = literalExpression "pkgs.lxc"; - description = '' + description = lib.mdDoc '' The LXC package to use with LXD (required for AppArmor profiles). ''; }; @@ -54,7 +54,7 @@ in { type = types.bool; default = config.boot.zfs.enabled; defaultText = literalExpression "config.boot.zfs.enabled"; - description = '' + description = lib.mdDoc '' Enables lxd to use zfs as a storage for containers. This option is enabled by default if a zfs pool is configured @@ -65,7 +65,7 @@ in { recommendedSysctlSettings = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables various settings to avoid common pitfalls when running containers requiring many file operations. Fixes errors like "Too many open files" or @@ -79,7 +79,7 @@ in { type = types.int; default = 600; apply = toString; - description = '' + description = lib.mdDoc '' Time to wait (in seconds) for LXD to become ready to process requests. If LXD does not reply within the configured time, lxd.service will be considered failed and systemd will attempt to restart it. diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix index deb9742a2c1..e2fb28ed633 100644 --- a/nixos/modules/virtualisation/nixos-containers.nix +++ b/nixos/modules/virtualisation/nixos-containers.nix @@ -293,18 +293,18 @@ let mountPoint = mkOption { example = "/mnt/usb"; type = types.str; - description = "Mount point on the container file system."; + description = lib.mdDoc "Mount point on the container file system."; }; hostPath = mkOption { default = null; example = "/home/alice"; type = types.nullOr types.str; - description = "Location of the host path to be mounted."; + description = lib.mdDoc "Location of the host path to be mounted."; }; isReadOnly = mkOption { default = true; type = types.bool; - description = "Determine whether the mounted path will be accessed in read-only mode."; + description = lib.mdDoc "Determine whether the mounted path will be accessed in read-only mode."; }; }; @@ -319,16 +319,16 @@ let node = mkOption { example = "/dev/net/tun"; type = types.str; - description = "Path to device node"; + description = lib.mdDoc "Path to device node"; }; modifier = mkOption { example = "rw"; type = types.str; - description = '' + description = lib.mdDoc '' Device node access modifier. Takes a combination - <literal>r</literal> (read), <literal>w</literal> (write), and - <literal>m</literal> (mknod). See the - <literal>systemd.resource-control(5)</literal> man page for more + `r` (read), `w` (write), and + `m` (mknod). See the + `systemd.resource-control(5)` man page for more information.''; }; }; @@ -346,7 +346,7 @@ let type = types.nullOr types.str; default = null; example = "br0"; - description = '' + description = lib.mdDoc '' Put the host-side of the veth-pair into the named bridge. Only one of hostAddress* or hostBridge can be given. ''; @@ -358,22 +358,22 @@ let protocol = mkOption { type = types.str; default = "tcp"; - description = "The protocol specifier for port forwarding between host and container"; + description = lib.mdDoc "The protocol specifier for port forwarding between host and container"; }; hostPort = mkOption { type = types.int; - description = "Source port of the external interface on host"; + description = lib.mdDoc "Source port of the external interface on host"; }; containerPort = mkOption { type = types.nullOr types.int; default = null; - description = "Target port of container"; + description = lib.mdDoc "Target port of container"; }; }; }); default = []; example = [ { protocol = "tcp"; hostPort = 8080; containerPort = 80; } ]; - description = '' + description = lib.mdDoc '' List of forwarded ports from host to container. Each forwarded port is specified by protocol, hostPort and containerPort. By default, protocol is tcp and hostPort and containerPort are assumed to be @@ -386,7 +386,7 @@ let type = types.nullOr types.str; default = null; example = "10.231.136.1"; - description = '' + description = lib.mdDoc '' The IPv4 address assigned to the host interface. (Not used when hostBridge is set.) ''; @@ -396,7 +396,7 @@ let type = types.nullOr types.str; default = null; example = "fc00::1"; - description = '' + description = lib.mdDoc '' The IPv6 address assigned to the host interface. (Not used when hostBridge is set.) ''; @@ -406,7 +406,7 @@ let type = types.nullOr types.str; default = null; example = "10.231.136.2"; - description = '' + description = lib.mdDoc '' The IPv4 address assigned to the interface in the container. If a hostBridge is used, this should be given with netmask to access the whole network. Otherwise the default netmask is /32 and routing is @@ -418,7 +418,7 @@ let type = types.nullOr types.str; default = null; example = "fc00::2"; - description = '' + description = lib.mdDoc '' The IPv6 address assigned to the interface in the container. If a hostBridge is used, this should be given with netmask to access the whole network. Otherwise the default netmask is /128 and routing is @@ -450,7 +450,7 @@ in boot.isContainer = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this NixOS machine is a lightweight container running in another NixOS system. ''; @@ -459,7 +459,7 @@ in boot.enableContainers = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable support for NixOS containers. Defaults to true (at no cost if containers are not actually used). ''; @@ -471,7 +471,7 @@ in { options = { config = mkOption { - description = '' + description = lib.mdDoc '' A specification of the desired configuration of this container, as a NixOS module. ''; @@ -513,9 +513,9 @@ in path = mkOption { type = types.path; example = "/nix/var/nix/profiles/per-container/webserver"; - description = '' + description = lib.mdDoc '' As an alternative to specifying - <option>config</option>, you can specify the path to + {option}`config`, you can specify the path to the evaluated NixOS system configuration, typically a symlink to a system profile. ''; @@ -525,7 +525,7 @@ in type = types.listOf types.str; default = []; example = [ "CAP_NET_ADMIN" "CAP_MKNOD" ]; - description = '' + description = lib.mdDoc '' Grant additional capabilities to the container. See the capabilities(7) and systemd-nspawn(1) man pages for more information. @@ -569,10 +569,10 @@ in enableTun = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allows the container to create and setup tunnel interfaces - by granting the <literal>NET_ADMIN</literal> capability and - enabling access to <literal>/dev/net/tun</literal>. + by granting the `NET_ADMIN` capability and + enabling access to `/dev/net/tun`. ''; }; @@ -594,7 +594,7 @@ in type = types.listOf types.str; default = []; example = [ "eth1" "eth2" ]; - description = '' + description = lib.mdDoc '' The list of interfaces to be moved into the container. ''; }; @@ -603,7 +603,7 @@ in type = types.listOf types.str; default = []; example = [ "eth1" "eth2" ]; - description = '' + description = lib.mdDoc '' The list of host interfaces from which macvlans will be created. For each interface specified, a macvlan interface will be created and moved to the container. @@ -613,7 +613,7 @@ in extraVeths = mkOption { type = with types; attrsOf (submodule { options = networkOptions; }); default = {}; - description = '' + description = lib.mdDoc '' Extra veth-pairs to be created for the container. ''; }; @@ -621,7 +621,7 @@ in autoStart = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the container is automatically started at boot-time. ''; }; @@ -648,7 +648,7 @@ in ''; description = - '' + lib.mdDoc '' An extra list of directories that is bound to the container. ''; }; @@ -657,7 +657,7 @@ in type = with types; listOf (submodule allowedDeviceOpts); default = []; example = [ { node = "/dev/net/tun"; modifier = "rw"; } ]; - description = '' + description = lib.mdDoc '' A list of device nodes to which the containers has access to. ''; }; @@ -666,7 +666,7 @@ in type = types.listOf types.str; default = []; example = [ "/var" ]; - description = '' + description = lib.mdDoc '' Mounts a set of tmpfs file systems into the container. Multiple paths can be specified. Valid items must conform to the --tmpfs argument @@ -678,7 +678,7 @@ in type = types.listOf types.str; default = []; example = [ "--drop-capability=CAP_SYS_CHROOT" ]; - description = '' + description = lib.mdDoc '' Extra flags passed to the systemd-nspawn command. See systemd-nspawn(1) for details. ''; diff --git a/nixos/modules/virtualisation/openstack-options.nix b/nixos/modules/virtualisation/openstack-options.nix index cbc779f27c8..eded418c9c9 100644 --- a/nixos/modules/virtualisation/openstack-options.nix +++ b/nixos/modules/virtualisation/openstack-options.nix @@ -28,13 +28,13 @@ in type = types.attrsOf (types.submodule { options = { mount = lib.mkOption { - description = "Where to mount this dataset."; + description = lib.mdDoc "Where to mount this dataset."; type = types.nullOr types.string; default = null; }; properties = lib.mkOption { - description = "Properties to set on this dataset."; + description = lib.mdDoc "Properties to set on this dataset."; type = types.attrsOf types.string; default = { }; }; diff --git a/nixos/modules/virtualisation/parallels-guest.nix b/nixos/modules/virtualisation/parallels-guest.nix index 53ad2ac708b..d3affe2b8f2 100644 --- a/nixos/modules/virtualisation/parallels-guest.nix +++ b/nixos/modules/virtualisation/parallels-guest.nix @@ -14,7 +14,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This enables Parallels Tools for Linux guests, along with provided video, mouse and other hardware drivers. ''; @@ -36,7 +36,7 @@ in default = config.boot.kernelPackages.prl-tools; defaultText = "config.boot.kernelPackages.prl-tools"; example = literalExpression "config.boot.kernelPackages.prl-tools"; - description = '' + description = lib.mdDoc '' Defines which package to use for prl-tools. Override to change the version. ''; }; diff --git a/nixos/modules/virtualisation/podman/dnsname.nix b/nixos/modules/virtualisation/podman/dnsname.nix index beef1975507..3e7d35ae1e4 100644 --- a/nixos/modules/virtualisation/podman/dnsname.nix +++ b/nixos/modules/virtualisation/podman/dnsname.nix @@ -16,7 +16,7 @@ in defaultNetwork.dnsname.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable DNS resolution in the default podman network. ''; }; diff --git a/nixos/modules/virtualisation/qemu-guest-agent.nix b/nixos/modules/virtualisation/qemu-guest-agent.nix index 39273e523e8..650fb241916 100644 --- a/nixos/modules/virtualisation/qemu-guest-agent.nix +++ b/nixos/modules/virtualisation/qemu-guest-agent.nix @@ -10,13 +10,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the qemu guest agent."; + description = lib.mdDoc "Whether to enable the qemu guest agent."; }; package = mkOption { type = types.package; default = pkgs.qemu_kvm.ga; defaultText = literalExpression "pkgs.qemu_kvm.ga"; - description = "The QEMU guest agent package."; + description = lib.mdDoc "The QEMU guest agent package."; }; }; diff --git a/nixos/modules/virtualisation/spice-usb-redirection.nix b/nixos/modules/virtualisation/spice-usb-redirection.nix index 255327f2622..ab2b058c686 100644 --- a/nixos/modules/virtualisation/spice-usb-redirection.nix +++ b/nixos/modules/virtualisation/spice-usb-redirection.nix @@ -3,7 +3,7 @@ options.virtualisation.spiceUSBRedirection.enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Install the SPICE USB redirection helper with setuid privileges. This allows unprivileged users to pass USB devices connected to this machine to libvirt VMs, both local and diff --git a/nixos/modules/virtualisation/virtualbox-guest.nix b/nixos/modules/virtualisation/virtualbox-guest.nix index 7b55b3b9759..94f70c65436 100644 --- a/nixos/modules/virtualisation/virtualbox-guest.nix +++ b/nixos/modules/virtualisation/virtualbox-guest.nix @@ -19,13 +19,13 @@ in enable = mkOption { default = false; type = types.bool; - description = "Whether to enable the VirtualBox service and other guest additions."; + description = lib.mdDoc "Whether to enable the VirtualBox service and other guest additions."; }; x11 = mkOption { default = true; type = types.bool; - description = "Whether to enable x11 graphics"; + description = lib.mdDoc "Whether to enable x11 graphics"; }; }; diff --git a/nixos/modules/virtualisation/virtualbox-host.nix b/nixos/modules/virtualisation/virtualbox-host.nix index 2acf54aae2e..4e47febed1b 100644 --- a/nixos/modules/virtualisation/virtualbox-host.nix +++ b/nixos/modules/virtualisation/virtualbox-host.nix @@ -44,7 +44,7 @@ in type = types.package; default = pkgs.virtualbox; defaultText = literalExpression "pkgs.virtualbox"; - description = '' + description = lib.mdDoc '' Which VirtualBox package to use. ''; }; @@ -52,7 +52,7 @@ in addNetworkInterface = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Automatically set up a vboxnet0 host-only network interface. ''; }; @@ -75,7 +75,7 @@ in headless = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use VirtualBox installation without GUI and Qt dependency. Useful to enable on servers and when virtual machines are controlled only via SSH. ''; @@ -84,7 +84,7 @@ in enableWebService = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Build VirtualBox web service tool (vboxwebsrv) to allow managing VMs via other webpage frontend tools. Useful for headless servers. ''; }; diff --git a/nixos/modules/virtualisation/vmware-guest.nix b/nixos/modules/virtualisation/vmware-guest.nix index d468a200872..61ff9da65af 100644 --- a/nixos/modules/virtualisation/vmware-guest.nix +++ b/nixos/modules/virtualisation/vmware-guest.nix @@ -17,7 +17,7 @@ in headless = mkOption { type = types.bool; default = false; - description = "Whether to disable X11-related features."; + description = lib.mdDoc "Whether to disable X11-related features."; }; }; diff --git a/nixos/modules/virtualisation/vmware-host.nix b/nixos/modules/virtualisation/vmware-host.nix index faa0d455c9d..b4869f0210d 100644 --- a/nixos/modules/virtualisation/vmware-host.nix +++ b/nixos/modules/virtualisation/vmware-host.nix @@ -41,18 +41,18 @@ in type = types.package; default = pkgs.vmware-workstation; defaultText = literalExpression "pkgs.vmware-workstation"; - description = "VMware host virtualisation package to use"; + description = lib.mdDoc "VMware host virtualisation package to use"; }; extraPackages = mkOption { type = with types; listOf package; default = with pkgs; [ ]; - description = "Extra packages to be used with VMware host."; + description = lib.mdDoc "Extra packages to be used with VMware host."; example = "with pkgs; [ ntfs3g ]"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Add extra config to /etc/vmware/config"; + description = lib.mdDoc "Add extra config to /etc/vmware/config"; example = '' # Allow unsupported device's OpenGL and Vulkan acceleration for guest vGPU mks.gl.allowUnsupportedDrivers = "TRUE" |