From 3eb3e31a8c6ced6cc56181325b69c59715fe9052 Mon Sep 17 00:00:00 2001 From: Steve Groesz Date: Sun, 23 Apr 2017 05:52:44 -0500 Subject: [PATCH] FAQ to explain warning when running --repair (#2393) FAQ to explain warning when running --repair, fixes #2341 --- docs/faq.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index f46d31d1c..786d527b1 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -347,7 +347,7 @@ How can I backup huge file(s) over a unstable connection? This is not a problem any more, see previous FAQ item. -How can I restore huge file(s) over a unstable connection? +How can I restore huge file(s) over an unstable connection? ---------------------------------------------------------- If you can not manage to extract the whole big file in one go, you can extract @@ -382,7 +382,7 @@ If you run into that, try this: .. _a_status_oddity: -I am seeing 'A' (added) status for a unchanged file!? +I am seeing 'A' (added) status for an unchanged file!? ----------------------------------------------------- The files cache is used to determine whether |project_name| already @@ -494,6 +494,28 @@ maybe open an issue in their issue tracker. Do not file an issue in the If you can reproduce the issue with the proven filesystem, please file an issue in the |project_name| issue tracker about that. + +Why does running 'borg check --repair' warn about data loss? +------------------------------------------------------------ + +Repair usually works for recovering data in a corrupted archive. However, +it's impossible to predict all modes of corruption. In some very rare +instances, such as malfunctioning storage hardware, additional repo +corruption may occur. If you can't afford to lose the repo, it's strongly +recommended that you perform repair on a copy of the repo. + +In other words, the warning is there to emphasize that |project_name|: + - Will perform automated routines that modify your backup repository + - Might not actually fix the problem you are experiencing + - Might, in very rare cases, further corrupt your repository + +In the case of malfunctioning hardware, such as a drive or USB hub +corrupting data when read or written, it's best to diagnose and fix the +cause of the initial corruption before attempting to repair the repo. If +the corruption is caused by a one time event such as a power outage, +running `borg check --repair` will fix most problems. + + Miscellaneous #############