[pbs-devel] [PATCH proxmox-backup] docs: client: mention missing catalog for split archives

[pbs-devel] [PATCH proxmox-backup] docs: client: mention missing catalog for split archives

[Christian Ebner]

Adds a note informing the users that the catalog is not encoded for
change detection modes set to `data` or `metadata`, and mention to
mount the snapshot archive as alternative for inspecting the content.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 docs/backup-client.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index e56e0625b..ca054a762 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -339,6 +339,13 @@ mode:
 
     # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
 
+.. Note:: Backup snapshots create with ``change-detection-mode`` set to ``data``
+  or ``metadata`` do not encode a dedicated catalog, as the metadata archive
+  already contains the same information in a quickly accessible manner.
+  Therefore, the ``proxmox-backup-client catalog`` commands are not available
+  for these snapshots, ``proxmox-backup-client mount`` can be used instead to
+  mount and inspect these snapshots.
+
 .. _client_encryption:
 
 Encryption
-- 
2.39.2



_______________________________________________
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] docs: client: mention missing catalog for split archives

[Gabriel Goller]

On 15.07.2024 16:42, Christian Ebner wrote:
>Adds a note informing the users that the catalog is not encoded for
>change detection modes set to `data` or `metadata`, and mention to
>mount the snapshot archive as alternative for inspecting the content.
>
>Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
>---
> docs/backup-client.rst | 7 +++++++
> 1 file changed, 7 insertions(+)
>
>diff --git a/docs/backup-client.rst b/docs/backup-client.rst
>index e56e0625b..ca054a762 100644
>--- a/docs/backup-client.rst
>+++ b/docs/backup-client.rst
>@@ -339,6 +339,13 @@ mode:
>
>     # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
>
>+.. Note:: Backup snapshots create with ``change-detection-mode`` set to ``data``

s/create/created/

>+  or ``metadata`` do not encode a dedicated catalog, as the metadata archive
>+  already contains the same information in a quickly accessible manner.
>+  Therefore, the ``proxmox-backup-client catalog`` commands are not available
>+  for these snapshots, ``proxmox-backup-client mount`` can be used instead to

                         ^
                         maybe insert 'and' instead of the comma?

>+  mount and inspect these snapshots.

                       ^
                      s/these snapshots/them/

>+
> .. _client_encryption:
>
> Encryption

Otherwise LGTM!



_______________________________________________
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] docs: client: mention missing catalog for split archives

[Christian Ebner]

Thanks for having a look at this Gabriel!

However the decision was made to instead implement the catalog commands 
for the split pxar case as well, by using the information provided by 
the metadata archive instead of the catalog.

Therefore, please ignore this patch.


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