From 283038056e1c1769abbed77c1a48891a56538526 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 30 Jun 2024 11:45:29 +0200 Subject: [PATCH] doc: suggest to follow troubleshooting steps if check reports error --- doc/045_working_with_repos.rst | 18 +++++++++++++++--- doc/077_troubleshooting.rst | 2 ++ 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/doc/045_working_with_repos.rst b/doc/045_working_with_repos.rst index 6b9666693..8dba8439f 100644 --- a/doc/045_working_with_repos.rst +++ b/doc/045_working_with_repos.rst @@ -368,10 +368,22 @@ detect this and yield the same error as when you tried to restore: $ restic -r /srv/restic-repo check ... load indexes - error: error loading index de30f323: load : invalid data returned - Fatal: LoadIndex returned errors + error: error loading index de30f3231ca2e6a59af4aa84216dfe2ef7339c549dc11b09b84000997b139628: LoadRaw(): invalid data returned -If the repository structure is intact, restic will show that no errors were found: + The repository index is damaged and must be repaired. You must run `restic repair index' to correct this. + + Fatal: repository contains errors + +.. warning:: + + If ``check`` reports an error in the repository, then you must repair the repository. + As long as a repository is damaged, restoring some files or directories will fail. New + snapshots are not guaranteed to be restorable either. + + For instructions how to repair a damaged repository, see the :ref:`troubleshooting` + section or follow the instructions provided by the ``check`` command. + +If the repository structure is intact, restic will show that ``no errors were found``: .. code-block:: console diff --git a/doc/077_troubleshooting.rst b/doc/077_troubleshooting.rst index 33302e9e0..36c9d63ec 100644 --- a/doc/077_troubleshooting.rst +++ b/doc/077_troubleshooting.rst @@ -10,6 +10,8 @@ ^ for subsubsections " for paragraphs +.. _troubleshooting: + ######################### Troubleshooting #########################