Add warning of the performance of prune

I went pretty loud with this, but I think the performance is bad enough
that it's really worth highlighting, especially since it locks the index
during the prune.
This commit is contained in:
Mike Lissner 2018-07-31 13:15:27 -07:00 committed by Alexander Neumann
parent 3151978f58
commit 2caf8edc55
1 changed files with 7 additions and 0 deletions

View File

@ -23,6 +23,13 @@ data that was referenced by the snapshot from the repository. This can
be automated with the ``--prune`` option of the ``forget`` command,
which runs ``prune`` automatically if snapshots have been removed.
.. Warning::
Pruning snapshots can be a very time-consuming process, taking nearly
as long as backups themselves. During a prune operation, the index is
locked and backups cannot be completed. Performance improvements are
planned for this feature.
It is advisable to run ``restic check`` after pruning, to make sure
you are alerted, should the internal data structures of the repository
be damaged.