* [pbs-devel] [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string
@ 2025-02-20 12:09 Christian Ebner
2025-02-20 12:09 ` [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions Christian Ebner
2025-02-20 15:20 ` [pbs-devel] partially-applied: [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Wolfgang Bumiller
0 siblings, 2 replies; 6+ messages in thread
From: Christian Ebner @ 2025-02-20 12:09 UTC (permalink / raw)
To: pbs-devel
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
pbs-client/src/backup_specification.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
index cd9e34243..b6fbc555c 100644
--- a/pbs-client/src/backup_specification.rs
+++ b/pbs-client/src/backup_specification.rs
@@ -35,7 +35,7 @@ pub fn parse_backup_specification(value: &str) -> Result<BackupSpecification, Er
"img" => BackupSpecificationType::IMAGE,
"conf" => BackupSpecificationType::CONFIG,
"log" => BackupSpecificationType::LOGFILE,
- _ => bail!("unknown backup source type '{}'", extension),
+ _ => bail!("unknown backup source type '{extension}'"),
};
return Ok(BackupSpecification {
archive_name,
@@ -44,7 +44,7 @@ pub fn parse_backup_specification(value: &str) -> Result<BackupSpecification, Er
});
}
- bail!("unable to parse backup source specification '{}'", value);
+ bail!("unable to parse backup source specification '{value}'");
}
#[api]
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions
2025-02-20 12:09 [pbs-devel] [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Christian Ebner
@ 2025-02-20 12:09 ` Christian Ebner
2025-02-20 15:22 ` Wolfgang Bumiller
2025-02-20 15:58 ` Christian Ebner
2025-02-20 15:20 ` [pbs-devel] partially-applied: [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Wolfgang Bumiller
1 sibling, 2 replies; 6+ messages in thread
From: Christian Ebner @ 2025-02-20 12:09 UTC (permalink / raw)
To: pbs-devel
Mention in the docs and the api parameter description the limitations
for archive name labels. They must contain alphanumerics, hyphens and
underscores only to match the regex pattern.
By setting this in the api parameter description, it will be included
in the man page for proxmox-backup-client.
Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6185
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
docs/backup-client.rst | 1 +
pbs-client/src/backup_specification.rs | 10 ++++++----
proxmox-backup-client/src/main.rs | 3 ++-
3 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 1c2a98ed8..e11c0142a 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -169,6 +169,7 @@ the client. The format is:
<archive-name>.<type>:<source-path>
+The ``archive-name`` must contain alphanumerics, hyphens and underscores only.
Common types are ``.pxar`` for file archives and ``.img`` for block
device images. To create a backup of a block device, run the following command:
diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
index b6fbc555c..ebf7f3f18 100644
--- a/pbs-client/src/backup_specification.rs
+++ b/pbs-client/src/backup_specification.rs
@@ -7,10 +7,12 @@ const_regex! {
BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(pxar|img|conf|log)):(.+)$";
}
-pub const BACKUP_SOURCE_SCHEMA: Schema =
- StringSchema::new("Backup source specification ([<label>:<path>]).")
- .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
- .schema();
+pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new(
+ r###"Backup source specification ([<label>:<path>]), the specification
+'label' must contain alphanumerics, hyphens and underscores only."###,
+)
+.format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
+.schema();
pub enum BackupSpecificationType {
PXAR,
diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
index 589a097bb..1647d480a 100644
--- a/proxmox-backup-client/src/main.rs
+++ b/proxmox-backup-client/src/main.rs
@@ -628,7 +628,8 @@ fn spawn_catalog_upload(
properties: {
backupspec: {
type: Array,
- description: "List of backup source specifications ([<label.ext>:<path>] ...)",
+ description: r###"List of backup source specifications ([<label.ext>:<path>] ...),
+the specifications 'label' must contain alphanumerics, hyphens and underscores only."###,
items: {
schema: BACKUP_SOURCE_SCHEMA,
}
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* [pbs-devel] partially-applied: [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string
2025-02-20 12:09 [pbs-devel] [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Christian Ebner
2025-02-20 12:09 ` [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions Christian Ebner
@ 2025-02-20 15:20 ` Wolfgang Bumiller
1 sibling, 0 replies; 6+ messages in thread
From: Wolfgang Bumiller @ 2025-02-20 15:20 UTC (permalink / raw)
To: Christian Ebner; +Cc: pbs-devel
applied this one, thanks
On Thu, Feb 20, 2025 at 01:09:19PM +0100, Christian Ebner wrote:
> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
> ---
> pbs-client/src/backup_specification.rs | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
> index cd9e34243..b6fbc555c 100644
> --- a/pbs-client/src/backup_specification.rs
> +++ b/pbs-client/src/backup_specification.rs
> @@ -35,7 +35,7 @@ pub fn parse_backup_specification(value: &str) -> Result<BackupSpecification, Er
> "img" => BackupSpecificationType::IMAGE,
> "conf" => BackupSpecificationType::CONFIG,
> "log" => BackupSpecificationType::LOGFILE,
> - _ => bail!("unknown backup source type '{}'", extension),
> + _ => bail!("unknown backup source type '{extension}'"),
> };
> return Ok(BackupSpecification {
> archive_name,
> @@ -44,7 +44,7 @@ pub fn parse_backup_specification(value: &str) -> Result<BackupSpecification, Er
> });
> }
>
> - bail!("unable to parse backup source specification '{}'", value);
> + bail!("unable to parse backup source specification '{value}'");
> }
>
> #[api]
> --
> 2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions
2025-02-20 12:09 ` [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions Christian Ebner
@ 2025-02-20 15:22 ` Wolfgang Bumiller
2025-02-20 15:27 ` Christian Ebner
2025-02-20 15:58 ` Christian Ebner
1 sibling, 1 reply; 6+ messages in thread
From: Wolfgang Bumiller @ 2025-02-20 15:22 UTC (permalink / raw)
To: Christian Ebner; +Cc: pbs-devel
On Thu, Feb 20, 2025 at 01:09:20PM +0100, Christian Ebner wrote:
> Mention in the docs and the api parameter description the limitations
> for archive name labels. They must contain alphanumerics, hyphens and
> underscores only to match the regex pattern.
>
> By setting this in the api parameter description, it will be included
> in the man page for proxmox-backup-client.
>
> Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6185
> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
> ---
> docs/backup-client.rst | 1 +
> pbs-client/src/backup_specification.rs | 10 ++++++----
> proxmox-backup-client/src/main.rs | 3 ++-
> 3 files changed, 9 insertions(+), 5 deletions(-)
>
> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
> index 1c2a98ed8..e11c0142a 100644
> --- a/docs/backup-client.rst
> +++ b/docs/backup-client.rst
> @@ -169,6 +169,7 @@ the client. The format is:
>
> <archive-name>.<type>:<source-path>
>
> +The ``archive-name`` must contain alphanumerics, hyphens and underscores only.
> Common types are ``.pxar`` for file archives and ``.img`` for block
> device images. To create a backup of a block device, run the following command:
>
> diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
> index b6fbc555c..ebf7f3f18 100644
> --- a/pbs-client/src/backup_specification.rs
> +++ b/pbs-client/src/backup_specification.rs
> @@ -7,10 +7,12 @@ const_regex! {
> BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(pxar|img|conf|log)):(.+)$";
> }
>
> -pub const BACKUP_SOURCE_SCHEMA: Schema =
> - StringSchema::new("Backup source specification ([<label>:<path>]).")
> - .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
> - .schema();
> +pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new(
> + r###"Backup source specification ([<label>:<path>]), the specification
> +'label' must contain alphanumerics, hyphens and underscores only."###,
Is there a reason for including a newline here?
Why not
"Backup source specification ([<label>:<path>]), the specification \
'label' must contain alphanumerics, hyphens and underscores only.",
When ending a regular quoted string with a backslash, the white space on
the next line is ignored for the resulting string, so this is the same
as:
"Backup source specification ([<label>:<path>]), the specification 'label' must contain alphanumerics, hyphens and underscores only.",
> +)
> +.format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
> +.schema();
>
> pub enum BackupSpecificationType {
> PXAR,
> diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
> index 589a097bb..1647d480a 100644
> --- a/proxmox-backup-client/src/main.rs
> +++ b/proxmox-backup-client/src/main.rs
> @@ -628,7 +628,8 @@ fn spawn_catalog_upload(
> properties: {
> backupspec: {
> type: Array,
> - description: "List of backup source specifications ([<label.ext>:<path>] ...)",
> + description: r###"List of backup source specifications ([<label.ext>:<path>] ...),
> +the specifications 'label' must contain alphanumerics, hyphens and underscores only."###,
This, too, is weirdly formatted.
> items: {
> schema: BACKUP_SOURCE_SCHEMA,
> }
> --
> 2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions
2025-02-20 15:22 ` Wolfgang Bumiller
@ 2025-02-20 15:27 ` Christian Ebner
0 siblings, 0 replies; 6+ messages in thread
From: Christian Ebner @ 2025-02-20 15:27 UTC (permalink / raw)
To: Wolfgang Bumiller; +Cc: pbs-devel
On 2/20/25 16:22, Wolfgang Bumiller wrote:
> On Thu, Feb 20, 2025 at 01:09:20PM +0100, Christian Ebner wrote:
>> Mention in the docs and the api parameter description the limitations
>> for archive name labels. They must contain alphanumerics, hyphens and
>> underscores only to match the regex pattern.
>>
>> By setting this in the api parameter description, it will be included
>> in the man page for proxmox-backup-client.
>>
>> Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6185
>> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
>> ---
>> docs/backup-client.rst | 1 +
>> pbs-client/src/backup_specification.rs | 10 ++++++----
>> proxmox-backup-client/src/main.rs | 3 ++-
>> 3 files changed, 9 insertions(+), 5 deletions(-)
>>
>> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
>> index 1c2a98ed8..e11c0142a 100644
>> --- a/docs/backup-client.rst
>> +++ b/docs/backup-client.rst
>> @@ -169,6 +169,7 @@ the client. The format is:
>>
>> <archive-name>.<type>:<source-path>
>>
>> +The ``archive-name`` must contain alphanumerics, hyphens and underscores only.
>> Common types are ``.pxar`` for file archives and ``.img`` for block
>> device images. To create a backup of a block device, run the following command:
>>
>> diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
>> index b6fbc555c..ebf7f3f18 100644
>> --- a/pbs-client/src/backup_specification.rs
>> +++ b/pbs-client/src/backup_specification.rs
>> @@ -7,10 +7,12 @@ const_regex! {
>> BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(pxar|img|conf|log)):(.+)$";
>> }
>>
>> -pub const BACKUP_SOURCE_SCHEMA: Schema =
>> - StringSchema::new("Backup source specification ([<label>:<path>]).")
>> - .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
>> - .schema();
>> +pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new(
>> + r###"Backup source specification ([<label>:<path>]), the specification
>> +'label' must contain alphanumerics, hyphens and underscores only."###,
>
> Is there a reason for including a newline here?
> Why not
>
> "Backup source specification ([<label>:<path>]), the specification \
> 'label' must contain alphanumerics, hyphens and underscores only.",
The newline was not intentional, no. Got unnoticed when looking at the
resulting output.
>
> When ending a regular quoted string with a backslash, the white space on
> the next line is ignored for the resulting string, so this is the same
> as:
>
> "Backup source specification ([<label>:<path>]), the specification 'label' must contain alphanumerics, hyphens and underscores only.",
>
>> +)
>> +.format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
>> +.schema();
>>
>> pub enum BackupSpecificationType {
>> PXAR,
>> diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
>> index 589a097bb..1647d480a 100644
>> --- a/proxmox-backup-client/src/main.rs
>> +++ b/proxmox-backup-client/src/main.rs
>> @@ -628,7 +628,8 @@ fn spawn_catalog_upload(
>> properties: {
>> backupspec: {
>> type: Array,
>> - description: "List of backup source specifications ([<label.ext>:<path>] ...)",
>> + description: r###"List of backup source specifications ([<label.ext>:<path>] ...),
>> +the specifications 'label' must contain alphanumerics, hyphens and underscores only."###,
>
> This, too, is weirdly formatted.
Acked, will send a v2 incorporating your feedback, thx!
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions
2025-02-20 12:09 ` [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions Christian Ebner
2025-02-20 15:22 ` Wolfgang Bumiller
@ 2025-02-20 15:58 ` Christian Ebner
1 sibling, 0 replies; 6+ messages in thread
From: Christian Ebner @ 2025-02-20 15:58 UTC (permalink / raw)
To: pbs-devel
Superseded-by version 2:
https://lore.proxmox.com/pbs-devel/20250220155605.229679-1-c.ebner@proxmox.com/T/#u
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2025-02-20 15:58 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-02-20 12:09 [pbs-devel] [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Christian Ebner
2025-02-20 12:09 ` [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions Christian Ebner
2025-02-20 15:22 ` Wolfgang Bumiller
2025-02-20 15:27 ` Christian Ebner
2025-02-20 15:58 ` Christian Ebner
2025-02-20 15:20 ` [pbs-devel] partially-applied: [PATCH proxmox-backup 1/2] client: style cleanup: inline variable names in format string Wolfgang Bumiller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal