Add descriptions to new configurations

This commit is contained in:
Manuel Thalmann 2024-05-01 04:54:38 +02:00
parent 3c402009ba
commit ef82a7b754

View file

@ -26,22 +26,26 @@ in {
virtualisation = { virtualisation = {
runAsRoot = lib.mkOption { runAsRoot = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
description = "Whether to launch the VM as root.";
default = false; default = false;
}; };
sharedHostKeys = lib.mkOption { sharedHostKeys = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
description = "Whether to share the local host SSH keys with the VM.";
default = false; default = false;
}; };
virt-viewer = lib.mkOption { virt-viewer = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
description = "Whether to use `remote-viewer` for displaying the VM.";
default = false; default = false;
}; };
qemu = { qemu = {
runInBackground = lib.mkOption { runInBackground = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
description = "Whether to run the QEMU command in a background job";
default = false; default = false;
}; };
@ -50,11 +54,13 @@ in {
bindAddress = lib.mkOption { bindAddress = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "The IP address for listening to incoming SPICE connections.";
default = "127.0.0.1"; default = "127.0.0.1";
}; };
port = lib.mkOption { port = lib.mkOption {
type = lib.types.port; type = lib.types.port;
description = "The port for listening to incoming SPICE connections.";
default = 5900; default = 5900;
}; };
}; };