[pbs-devel] [PATCH proxmox-backup 1/1] client: fix example commands for client usage

[pbs-devel] [PATCH proxmox-backup 1/1] client: fix example commands for client usage

[Stefan Hanreich]

The example commands in the Change Detection Mode / File Exclusion
section are missing the command in the client invocation. Add the
backup command to the examples, so they are actually valid.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 docs/backup-client.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 3c6941ae..f2b5273c 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -272,13 +272,13 @@ parameter. For example:
 
 .. code-block:: console
 
-    # proxmox-backup-client backup.pxar:./linux --exclude /usr
+    # proxmox-backup-client backup backup.pxar:./linux --exclude /usr
 
 Multiple paths can be excluded like this:
 
 .. code-block:: console
 
-    # proxmox-backup-client backup.pxar:./linux --exclude=/usr --exclude=/rust
+    # proxmox-backup-client backup backup.pxar:./linux --exclude=/usr --exclude=/rust
 
 .. _client_change_detection_mode:
 
@@ -329,7 +329,7 @@ mode:
 
 .. code-block:: console
 
-    # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
+    # proxmox-backup-client backup backup.pxar:./linux --change-detection-mode=metadata
 
 .. _client_encryption:
 
-- 
2.39.5


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

[pbs-devel] applied: [PATCH proxmox-backup 1/1] client: fix example commands for client usage

[Fabian Grünbichler]

thanks!

On November 26, 2024 12:04 pm, Stefan Hanreich wrote:
> The example commands in the Change Detection Mode / File Exclusion
> section are missing the command in the client invocation. Add the
> backup command to the examples, so they are actually valid.
> 
> Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
> ---
>  docs/backup-client.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
> index 3c6941ae..f2b5273c 100644
> --- a/docs/backup-client.rst
> +++ b/docs/backup-client.rst
> @@ -272,13 +272,13 @@ parameter. For example:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --exclude /usr
> +    # proxmox-backup-client backup backup.pxar:./linux --exclude /usr
>  
>  Multiple paths can be excluded like this:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --exclude=/usr --exclude=/rust
> +    # proxmox-backup-client backup backup.pxar:./linux --exclude=/usr --exclude=/rust
>  
>  .. _client_change_detection_mode:
>  
> @@ -329,7 +329,7 @@ mode:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
> +    # proxmox-backup-client backup backup.pxar:./linux --change-detection-mode=metadata
>  
>  .. _client_encryption:
>  
> -- 
> 2.39.5
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

Re: [pbs-devel] [PATCH proxmox-backup 1/1] client: fix example commands for client usage

[Thomas Lamprecht]

Am 26.11.24 um 12:04 schrieb Stefan Hanreich:
> The example commands in the Change Detection Mode / File Exclusion
> section are missing the command in the client invocation. Add the
> backup command to the examples, so they are actually valid.
> 
> Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
> ---
>  docs/backup-client.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
> index 3c6941ae..f2b5273c 100644
> --- a/docs/backup-client.rst
> +++ b/docs/backup-client.rst
> @@ -272,13 +272,13 @@ parameter. For example:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --exclude /usr
> +    # proxmox-backup-client backup backup.pxar:./linux --exclude /usr
>  
>  Multiple paths can be excluded like this:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --exclude=/usr --exclude=/rust
> +    # proxmox-backup-client backup backup.pxar:./linux --exclude=/usr --exclude=/rust
>  
>  .. _client_change_detection_mode:
>  
> @@ -329,7 +329,7 @@ mode:
>  
>  .. code-block:: console
>  
> -    # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
> +    # proxmox-backup-client backup backup.pxar:./linux --change-detection-mode=metadata

Fabian already applied this, but I'd also change the target pxar file name,
using "backup" for that is probably the the source  of the original mistake
and is IMO quite likely to confuse users, double words are often skipped
unconsciously by the brain (for some proven if they have missed the double
the in the second line ;)

>  
>  .. _client_encryption:
>  



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

Re: [pbs-devel] [PATCH proxmox-backup 1/1] client: fix example commands for client usage

[Stefan Hanreich]

On 11/26/24 12:12, Thomas Lamprecht wrote:
> Fabian already applied this, but I'd also change the target pxar file name,
> using "backup" for that is probably the the source  of the original mistake
> and is IMO quite likely to confuse users, double words are often skipped
> unconsciously by the brain (for some proven if they have missed the double
> the in the second line ;)

that is true indeed, sent another patch ;)


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel