TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-10-09 07:33:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename 'rebuild-index' to 'repair index'

Browse Source 
The old name still works, but is deprecated.
This commit is contained in:
Michael Eischer
2022-12-27 18:25:39 +01:00
parent db459eda21
commit 118d599d0a
10 changed files with 57 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/060_forget.rst
View File

@@ -472,7 +472,7 @@ space. However, a **failed** ``prune`` run can cause the repository to become
**temporarily unusable**. Therefore, make sure that you have a stable connection to the
repository storage, before running this command. In case the command fails, it may become
necessary to manually remove all files from the `index/` folder of the repository and
run `rebuild-index` afterwards.
run `repair index` afterwards.
To prevent accidental usages of the ``--unsafe-recover-no-free-space`` option it is
necessary to first run ``prune --unsafe-recover-no-free-space SOME-ID`` and then replace

12
doc/077_troubleshooting.rst
View File

@@ -58,17 +58,17 @@ But make sure that your needed data is also still contained in your repository ;
Note that `check` also prints out warning in some cases. These warnings point out that the repo may be
optimized but is still in perfect shape and does not need any troubleshooting.
3. Index trouble -> `rebuild-index`
3. Index trouble -> `repair index`
********************************************
A common problem with broken repostories is that the index does no longer correctly represent the contents
of your pack files. This is especially the case if some pack files got lost.
`rebuild-index` recovers this situation and ensures that the index exactly represents the pack files.
`repair index` recovers this situation and ensures that the index exactly represents the pack files.
You might even need to manually remove corrupted pack files. In this case make sure, you run
`restic rebuild-index` after.
`restic repair index` after.
Also if you encounter problems with the index files itselves, `rebuild-index` will solve these problems
Also if you encounter problems with the index files itselves, `repair index` will solve these problems
immediately.
However, rebuilding the index does not solve every problem, e.g. lost pack files.
@@ -91,7 +91,7 @@ backup again and check if this did heal your repository.
If you realize that a specific file is broken in your repository and you have this file, any run of
`backup` which includes that file will be able to heal the situation.
Note that `backup` relies on a correct index state, so make sure your index is fine or run `rebuild-index`
Note that `backup` relies on a correct index state, so make sure your index is fine or run `repair index`
before running `backup`.
6. Unreferenced tree -> `recover`
@@ -101,7 +101,7 @@ If for some reason you have unreferenced trees in your repository but you actual
`recover` it will generate a new snapshot which allows access to all trees that you have in your
repository.
Note that `recover` relies on a correct index state, so make sure your index is fine or run `rebuild-index`
Note that `recover` relies on a correct index state, so make sure your index is fine or run `repair index`
before running `recover`.
7. Repair defect snapshots using `repair`

2
doc/manual_rest.rst
View File

@@ -35,8 +35,8 @@ Usage help is available:
migrate Apply migrations
mount Mount the repository
prune Remove unneeded data from the repository
rebuild-index Build a new index
recover Recover data from the repository not referenced by snapshots
repair Repair the repository
restore Extract the data from a snapshot
rewrite Rewrite snapshots to exclude unwanted files
self-update Update the restic binary