summaryrefslogtreecommitdiffstats
path: root/docs/usage/check.rst.inc
diff options
context:
space:
mode:
authorJames Buren <braewoods+mgh@braewoods.net>2021-06-17 00:24:32 -0500
committerJames Buren <braewoods+mgh@braewoods.net>2021-06-18 01:26:57 -0500
commit8394ae69326b94873c9021bda1fac227359927cf (patch)
treec08d217ec849ed4e2ae1112b9fc4395cf02d647c /docs/usage/check.rst.inc
parent4b9e99308c5753e98ce16eb24c861f8d89b6ed1e (diff)
add notice about defective hardware to check documentation (#5753)
Diffstat (limited to 'docs/usage/check.rst.inc')
-rw-r--r--docs/usage/check.rst.inc5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index 9dce5c204..1cb27c862 100644
--- a/docs/usage/check.rst.inc
+++ b/docs/usage/check.rst.inc
@@ -90,6 +90,11 @@ The check command verifies the consistency of a repository and the corresponding
check --repair is a potentially dangerous function and might lead to data loss
(for kinds of corruption it is not capable of dealing with). BE VERY CAREFUL!
+Pursuant to the previous warning it is also highly recommended to test the
+reliability of the hardware running this software with stress testing software
+such as memory testers. Unreliable hardware can also lead to data loss especially
+when this command is run in repair mode.
+
First, the underlying repository data files are checked:
- For all segments, the segment magic header is checked.