From e90cf8a32f3f54b7d1885bf0e2d26d2a3ce66c83 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 12 Apr 2022 18:43:52 +0200 Subject: [PATCH] docs: improve borg check --max-duration description --- src/borg/archiver.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 81677b04a..bd640af0e 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -3362,15 +3362,18 @@ def define_borg_mount(parser): The ``--max-duration`` option can be used to split a long-running repository check into multiple partial checks. After the given number of seconds the check is interrupted. The next partial check will continue where the previous one stopped, - until the complete repository has been checked. Example: Assuming a full check took 7 + until the complete repository has been checked. Example: Assuming a complete check took 7 hours, then running a daily check with --max-duration=3600 (1 hour) resulted in one - full check per week. + completed check per week. - Attention: Partial checks can only do way less checking than a full check (only the - CRC32 checks on segment file entries are done), and cannot be combined with the - ``--repair`` option. Partial checks may therefore be useful only with very large - repositories where a full check took too long. Doing a full repository check aborts a - partial check; the next partial check will restart from the beginning. + Attention: A partial --repository-only check can only do way less checking than a full + --repository-only check: only the non-cryptographic checksum checks on segment file + entries are done, while a full --repository-only check would also do a repo index check. + A partial check cannot be combined with the ``--repair`` option. Partial checks + may therefore be useful only with very large repositories where a full check would take + too long. + Doing a full repository check aborts a partial check; the next partial check will restart + from the beginning. The ``--verify-data`` option will perform a full integrity verification (as opposed to checking the CRC32 of the segment) of data, which means reading the data from the