octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-12-22 10:58:55 +00:00
Code Issues Releases Wiki Activity

doc: improve description of caching behavior of the check command

Browse Source
This commit is contained in:
Michael Eischer 2023-06-17 15:45:54 +02:00
parent aea7538936
commit 8dcb0c4a9d
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/045_working_with_repos.rst
View File

@ -232,6 +232,8 @@ modifying the repository. Instead restic will only print the actions it would
perform. perform.
.. _checking-integrity:
Checking integrity and consistency Checking integrity and consistency
================================== ==================================
@ -284,6 +286,14 @@ If the repository structure is intact, restic will show that no errors were foun
check snapshots, trees and blobs check snapshots, trees and blobs
no errors were found no errors were found
By default, check creates a new temporary cache directory to verify that the
data stored in the repository is intact. To reuse the existing cache, you can
use the ``--with-cache`` flag.
If the cache directory is not explicitly set, then ``check`` creates its
temporary cache directory in the temporary directory, see :ref:`temporary_files`.
Otherwise, the specified cache directory is used, as described in :ref:`caching`.
By default, the ``check`` command does not verify that the actual pack files By default, the ``check`` command does not verify that the actual pack files
on disk in the repository are unmodified, because doing so requires reading on disk in the repository are unmodified, because doing so requires reading
a copy of every pack file in the repository. To tell restic to also verify the a copy of every pack file in the repository. To tell restic to also verify the

7
doc/manual_rest.rst
View File

@ -418,8 +418,6 @@ instead of the default, set the environment variable like this:
$ restic -r /srv/restic-repo backup ~/work $ restic -r /srv/restic-repo backup ~/work
If the environment variable ``$RESTIC_CACHE_DIR`` is not set, ``check`` creates its temporary cache directory in the temporary directory. If ``$RESTIC_CACHE_DIR`` is set, ``check`` creates its temporary cache directory in ``$RESTIC_CACHE_DIR``.
.. _caching: .. _caching:
Caching Caching
@ -443,6 +441,10 @@ The command line parameter ``--cache-dir`` or the environment variable
parameter ``--no-cache`` disables the cache entirely. In this case, all data parameter ``--no-cache`` disables the cache entirely. In this case, all data
is loaded from the repository. is loaded from the repository.
If a cache location is explicitly specified, then the ``check`` command will use
that location to store its temporary cache. See :ref:`checking-integrity` for
more details.
The cache is ephemeral: When a file cannot be read from the cache, it is loaded The cache is ephemeral: When a file cannot be read from the cache, it is loaded
from the repository. from the repository.
@ -452,4 +454,3 @@ time it is used, so by looking at the timestamps of the sub directories of the
cache directory it can decide which sub directories are old and probably not cache directory it can decide which sub directories are old and probably not
needed any more. You can either remove these directories manually, or run a needed any more. You can either remove these directories manually, or run a
restic command with the ``--cleanup-cache`` flag. restic command with the ``--cleanup-cache`` flag.