proxmox-mirrors/proxmox-backup
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox-backup synced 2025-08-10 12:51:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

client: align description for backup specification to docs

Browse Source 
Adapt the description for the backup specification to use
`archive-name` and `type` over `label` and `ext`, to be in line with
the terminology used in the documentation.

Further, explicitley describe the `path` as `source-path` to be less
ambigouos.

In order to avoid formatting issues in the man pages because of line
breaks after a hyphen, show the backup specification description in
multiple lines.

Suggested-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
This commit is contained in:
Christian Ebner 2025-03-18 12:11:34 +01:00 committed by Thomas Lamprecht
parent b693f5d471
commit 24a6d4fd82
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pbs-client/src/backup_specification.rs
View File

@ -8,8 +8,9 @@ const_regex! {
} }
pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new( pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new(
"Backup source specification ([<label>:<path>]), the specification \ "Backup source specification ([<archive-name>.<type>:<source-path>]), the \
'label' must contain alphanumerics, hyphens and underscores only.", 'archive-name' must contain alphanumerics, hyphens and underscores only. \
The 'type' must be either 'pxar', 'img', 'conf' or 'log'.",
) )
.format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)) .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
.schema(); .schema();

7
proxmox-backup-client/src/main.rs
View File

@ -631,9 +631,10 @@ fn spawn_catalog_upload(
backupspec: { backupspec: {
type: Array, type: Array,
description: description:
"List of backup source specifications ([<label.ext>:<path>] ...), the \ "List of backup source specifications:\
specifications 'label' must contain alphanumerics, hyphens and underscores \ \n\n[<archive-name>.<type>:<source-path>] ...\n\n\
only.", The 'archive-name' must only contain alphanumerics, hyphens and underscores \
while the 'type' must be either 'pxar', 'img', 'conf' or 'log'.",
items: { items: {
schema: BACKUP_SOURCE_SCHEMA, schema: BACKUP_SOURCE_SCHEMA,
} }