resolve clarify borg check --verify-data (#5808)

borgbackup · Jun 18, 2021 · 4f9e30e · 4f9e30e
1 parent 64bbe39
commit 4f9e30e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
@@ -125,6 +125,10 @@ Second, the consistency and correctness of the archive metadata is verified:
 - In repair mode, when all the archives were checked, orphaned chunks are deleted
   from the repo. One cause of orphaned chunks are input file related errors (like
   read errors) in the archive creation process.
+- In verify-data mode, a complete cryptographic verification of the archive data
+  integrity is performed. This conflicts with ``--repository-only`` as this mode
+  only makes sense if the archive checks are enabled. The full details of this mode
+  are documented below.
 - If checking a remote repo via ``ssh:``, the archive check is executed on the
   client machine because it requires decryption, and this is always done client-side
   as key access is needed.

diff --git a/src/borg/archiver.py b/src/borg/archiver.py
@@ -3072,6 +3072,10 @@ def define_borg_mount(parser):
         - In repair mode, when all the archives were checked, orphaned chunks are deleted
           from the repo. One cause of orphaned chunks are input file related errors (like
           read errors) in the archive creation process.
+        - In verify-data mode, a complete cryptographic verification of the archive data
+          integrity is performed. This conflicts with ``--repository-only`` as this mode
+          only makes sense if the archive checks are enabled. The full details of this mode
+          are documented below.
         - If checking a remote repo via ``ssh:``, the archive check is executed on the
           client machine because it requires decryption, and this is always done client-side
           as key access is needed.