all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Christian Ebner <c.ebner@proxmox.com>
To: Wolfgang Bumiller <w.bumiller@proxmox.com>
Cc: pbs-devel@lists.proxmox.com
Subject: Re: [pbs-devel] [PATCH proxmox-backup 2/2] fix #6185: client/docs: explicitly mention archive name restrictions
Date: Thu, 20 Feb 2025 16:27:26 +0100	[thread overview]
Message-ID: <cee65ec6-5d14-4e04-a47b-601608a42f87@proxmox.com> (raw)
In-Reply-To: <nagb4opq4rwfgglysudalorubwddntxdg4ysm3mqaqfbr7yx75@bxp4qso7awvo>

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


  reply	other threads:[~2025-02-20 15:28 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cee65ec6-5d14-4e04-a47b-601608a42f87@proxmox.com \
    --to=c.ebner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    --cc=w.bumiller@proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal