vzdump: fixup style for multi-line literal strings

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2023-11-21 13:29:43 +01:00
parent e5278e9827
commit 06c318c45e

View File

@ -89,9 +89,9 @@ PVE::JSONSchema::register_format('backup-performance', {
optional => 1, optional => 1,
}, },
'pbs-entries-max' => { 'pbs-entries-max' => {
description => "Applies to container backups sent to PBS. Limits the number of entries " description => "Applies to container backups sent to PBS. Limits the number of entries"
."allowed in memory at a given time to avoid unintended OOM situations. Increase it to " ." allowed in memory at a given time to avoid unintended OOM situations. Increase it to"
."enable backups of containers with a large amount of files.", ." enable backups of containers with a large amount of files.",
type => 'integer', type => 'integer',
minimum => 1, minimum => 1,
default => 1048576, default => 1048576,
@ -132,15 +132,15 @@ my $confdesc = {
}, },
pigz=> { pigz=> {
type => "integer", type => "integer",
description => "Use pigz instead of gzip when N>0.". description => "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as"
" N=1 uses half of cores, N>1 uses N as thread count.", ." thread count.",
optional => 1, optional => 1,
default => 0, default => 0,
}, },
zstd => { zstd => {
type => "integer", type => "integer",
description => "Zstd threads. N=0 uses half of the available cores,". description => "Zstd threads. N=0 uses half of the available cores, if N is set to a value"
" N>0 uses N as thread count.", ." bigger than 0, N is used as thread count.",
optional => 1, optional => 1,
default => 1, default => 1,
}, },
@ -164,9 +164,9 @@ my $confdesc = {
}, },
'exclude-path' => { 'exclude-path' => {
type => 'array', type => 'array',
description => "Exclude certain files/directories (shell globs)." . description => "Exclude certain files/directories (shell globs). Paths starting with '/'"
" Paths starting with '/' are anchored to the container's root, " . ." are anchored to the container's root, other paths match relative to each"
" other paths match relative to each subdirectory.", ." subdirectory.",
optional => 1, optional => 1,
items => { items => {
type => 'string', type => 'string',
@ -175,9 +175,8 @@ my $confdesc = {
mailto => { mailto => {
type => 'string', type => 'string',
format => 'email-or-username-list', format => 'email-or-username-list',
description => "Deprecated: Use notification targets/matchers instead." . description => "Deprecated: Use notification targets/matchers instead. Comma-separated list"
" Comma-separated list of email addresses or users that should" . ." of email addresses or users that should receive email notifications.",
" receive email notifications.",
optional => 1, optional => 1,
}, },
mailnotification => { mailnotification => {
@ -190,16 +189,14 @@ my $confdesc = {
}, },
'notification-mode' => { 'notification-mode' => {
type => 'string', type => 'string',
description => "Determine which notification system to use." . description => "Determine which notification system to use. If set to 'legacy-sendmail',"
" If set to 'legacy-sendmail', vzdump will consider the" . ." vzdump will consider the mailto/mailnotification parameters and send emails to the"
" mailto/mailnotification parameters and send emails to the" . ." specified address(es) via the 'sendmail' command. If set to 'notification-system',"
" specified address(es) via the 'sendmail' command." . ." a notification will be sent via PVE's notification system, and the mailto and"
" If set to 'notification-system', a notification will be sent via PVE's" . ." mailnotification will be ignored. If set to 'auto' (default setting), an email will"
" notification system and mailto/mailnotification will be ignored" . ." be sent if mailto is set, and the notification system will be used if not.",
" If set to 'auto' (default setting), an email will be sent if " .
" mailto is set, and the notification system will be used if not.",
optional => 1, optional => 1,
enum => [ 'auto', 'legacy-sendmail', 'notification-system'], enum => ['auto', 'legacy-sendmail', 'notification-system'],
default => 'auto', default => 'auto',
}, },
'notification-policy' => { 'notification-policy' => {
@ -250,10 +247,10 @@ my $confdesc = {
}, },
ionice => { ionice => {
type => 'integer', type => 'integer',
description => "Set IO priority when using the BFQ scheduler. For snapshot and suspend " description => "Set IO priority when using the BFQ scheduler. For snapshot and suspend"
."mode backups of VMs, this only affects the compressor. A value of 8 means the idle " ." mode backups of VMs, this only affects the compressor. A value of 8 means the idle"
."priority is used, otherwise the best-effort priority is used with the specified " ." priority is used, otherwise the best-effort priority is used with the specified"
."value.", ." value.",
optional => 1, optional => 1,
minimum => 0, minimum => 0,
maximum => 8, maximum => 8,
@ -305,11 +302,11 @@ my $confdesc = {
}, },
'notes-template' => { 'notes-template' => {
type => 'string', type => 'string',
description => "Template string for generating notes for the backup(s). It can contain ". description => "Template string for generating notes for the backup(s). It can contain"
"variables which will be replaced by their values. Currently supported are ". ." variables which will be replaced by their values. Currently supported are"
"{{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the ". ." {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the"
"future. Needs to be a single line, newline and backslash need to be escaped as '\\n' ". ." future. Needs to be a single line, newline and backslash need to be escaped as '\\n'"
"and '\\\\' respectively.", ." and '\\\\' respectively.",
requires => 'storage', requires => 'storage',
maxLength => 1024, maxLength => 1024,
optional => 1, optional => 1,