summaryrefslogtreecommitdiffstats
path: root/docs/usage
diff options
context:
space:
mode:
authorJames Buren <braewoods+mgh@braewoods.net>2021-06-18 12:58:44 -0500
committerJames Buren <braewoods+mgh@braewoods.net>2021-06-18 15:00:14 -0500
commit4f9e30e980adc57d4825c7bad93a509f92ade653 (patch)
treef91434e5d4507393bf94523fac4d0bd06524b105 /docs/usage
parent64bbe399df7d7e61402c80a7f44a43a2352dc4e1 (diff)
resolve clarify borg check --verify-data (#5808)
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/check.rst.inc4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index 1cb27c862..e4e530a2e 100644
--- 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.