[pbs-devel] [RFC PATCH 4/4] fix #3786: docs: document deep sync behavior and prerequisites

[Stefan Sterz <s.sterz@proxmox.com>]

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
---
 docs/managing-remotes.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
index 0af3dd60..ff639054 100644
--- a/docs/managing-remotes.rst
+++ b/docs/managing-remotes.rst
@@ -95,6 +95,12 @@ the local datastore as well. If the ``owner`` option is not set (defaulting to
 ``root@pam``) or is set to something other than the configuring user,
 ``Datastore.Modify`` is required as well.
 
+Enabling the advanced option ``deep-sync`` will re-sync all snapshots that have
+failed to verify during the last :ref:`maintenance_verification`. Hence, a
+verification job needs to be run before a deep sync job can be carried out. Be
+aware that a deep sync needs to check the manifests of all snapshots in a
+datastore and might take much longer than regular sync jobs.
+
 If the ``group-filter`` option is set, only backup groups matching at least one
 of the specified criteria are synced. The available criteria are:
 
-- 
2.30.2