fix overly long/short lines and typos

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2021-10-20 08:24:08 +02:00
parent 179b9f1ba5
commit 8d88a59433

View File

@ -87,12 +87,10 @@ my $OVMF = {
my $cpuinfo = PVE::ProcFSTools::read_cpuinfo(); my $cpuinfo = PVE::ProcFSTools::read_cpuinfo();
# Note about locking: we use flock on the config file protect # Note about locking: we use flock on the config file protect against concurent actions.
# against concurent actions. # Aditionaly, we have a 'lock' setting in the config file. This can be set to 'migrate',
# Aditionaly, we have a 'lock' setting in the config file. This # 'backup', 'snapshot' or 'rollback'. Most actions are not allowed when such lock is set.
# can be set to 'migrate', 'backup', 'snapshot' or 'rollback'. Most actions are not # But you can ignore this kind of lock with the --skiplock flag.
# allowed when such lock is set. But you can ignore this kind of
# lock with the --skiplock flag.
cfs_register_file('/qemu-server/', cfs_register_file('/qemu-server/',
\&parse_vm_config, \&parse_vm_config,
@ -163,7 +161,7 @@ PVE::JSONSchema::register_format('pve-qm-watchdog', $watchdog_fmt);
my $agent_fmt = { my $agent_fmt = {
enabled => { enabled => {
description => "Enable/disable Qemu GuestAgent.", description => "Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.",
type => 'boolean', type => 'boolean',
default => 0, default => 0,
default_key => 1, default_key => 1,
@ -252,33 +250,29 @@ my $rng_fmt = {
type => 'string', type => 'string',
enum => ['/dev/urandom', '/dev/random', '/dev/hwrng'], enum => ['/dev/urandom', '/dev/random', '/dev/hwrng'],
default_key => 1, default_key => 1,
description => "The file on the host to gather entropy from. In most" description => "The file on the host to gather entropy from. In most cases '/dev/urandom'"
. " cases /dev/urandom should be preferred over /dev/random" ." should be preferred over '/dev/random' to avoid entropy-starvation issues on the"
. " to avoid entropy-starvation issues on the host. Using" ." host. Using urandom does *not* decrease security in any meaningful way, as it's"
. " urandom does *not* decrease security in any meaningful" ." still seeded from real entropy, and the bytes provided will most likely be mixed"
. " way, as it's still seeded from real entropy, and the" ." with real entropy on the guest as well. '/dev/hwrng' can be used to pass through"
. " bytes provided will most likely be mixed with real" ." a hardware RNG from the host.",
. " entropy on the guest as well. /dev/hwrng can be used"
. " to pass through a hardware RNG from the host.",
}, },
max_bytes => { max_bytes => {
type => 'integer', type => 'integer',
description => "Maximum bytes of entropy injected into the guest every" description => "Maximum bytes of entropy allowed to get injected into the guest every"
. " 'period' milliseconds. Prefer a lower value when using" ." 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use"
. " /dev/random as source. Use 0 to disable limiting" ." `0` to disable limiting (potentially dangerous!).",
. " (potentially dangerous!).",
optional => 1, optional => 1,
# default is 1 KiB/s, provides enough entropy to the guest to avoid # default is 1 KiB/s, provides enough entropy to the guest to avoid boot-starvation issues
# boot-starvation issues (e.g. systemd etc...) while allowing no chance # (e.g. systemd etc...) while allowing no chance of overwhelming the host, provided we're
# of overwhelming the host, provided we're reading from /dev/urandom # reading from /dev/urandom
default => 1024, default => 1024,
}, },
period => { period => {
type => 'integer', type => 'integer',
description => "Every 'period' milliseconds the entropy-injection quota" description => "Every 'period' milliseconds the entropy-injection quota is reset, allowing"
. " is reset, allowing the guest to retrieve another" ." the guest to retrieve another 'max_bytes' of entropy.",
. " 'max_bytes' of entropy.",
optional => 1, optional => 1,
default => 1000, default => 1000,
}, },
@ -300,7 +294,9 @@ my $confdesc = {
hotplug => { hotplug => {
optional => 1, optional => 1,
type => 'string', format => 'pve-hotplug-features', type => 'string', format => 'pve-hotplug-features',
description => "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", description => "Selectively enable hotplug features. This is a comma separated list of"
." hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable"
." hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`.",
default => 'network,disk,usb', default => 'network,disk,usb',
}, },
reboot => { reboot => {
@ -319,7 +315,8 @@ my $confdesc = {
optional => 1, optional => 1,
type => 'number', type => 'number',
description => "Limit of CPU usage.", description => "Limit of CPU usage.",
verbose_description => "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.", verbose_description => "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has"
." total of '2' CPU time. Value '0' indicates no CPU limit.",
minimum => 0, minimum => 0,
maximum => 128, maximum => 128,
default => 0, default => 0,
@ -338,7 +335,8 @@ my $confdesc = {
memory => { memory => {
optional => 1, optional => 1,
type => 'integer', type => 'integer',
description => "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", description => "Amount of RAM for the VM in MB. This is the maximum available memory when"
." you use the balloon device.",
minimum => 16, minimum => 16,
default => 512, default => 512,
}, },
@ -351,7 +349,9 @@ my $confdesc = {
shares => { shares => {
optional => 1, optional => 1,
type => 'integer', type => 'integer',
description => "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.", description => "Amount of memory shares for auto-ballooning. The larger the number is, the"
." more memory this VM gets. Number is relative to weights of all other running VMs."
." Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
minimum => 0, minimum => 0,
maximum => 50000, maximum => 50000,
default => 1000, default => 1000,
@ -359,8 +359,8 @@ my $confdesc = {
keyboard => { keyboard => {
optional => 1, optional => 1,
type => 'string', type => 'string',
description => "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.". description => "Keyboard layout for VNC server. The default is read from the"
"It should not be necessary to set it.", ."'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.",
enum => PVE::Tools::kvmkeymaplist(), enum => PVE::Tools::kvmkeymaplist(),
default => undef, default => undef,
}, },
@ -475,7 +475,7 @@ EODESC
}, },
agent => { agent => {
optional => 1, optional => 1,
description => "Enable/disable Qemu GuestAgent and its properties.", description => "Enable/disable communication with the Qemu Guest Agent and its properties.",
type => 'string', type => 'string',
format => $agent_fmt, format => $agent_fmt,
}, },
@ -494,8 +494,8 @@ EODESC
localtime => { localtime => {
optional => 1, optional => 1,
type => 'boolean', type => 'boolean',
description => "Set the real time clock to local time. This is enabled by default if ostype" description => "Set the real time clock (RTC) to local time. This is enabled by default if"
." indicates a Microsoft OS.", ." the `ostype` indicates a Microsoft Windows OS.",
}, },
freeze => { freeze => {
optional => 1, optional => 1,