clarify borg upgrade docs, fixes #2436

This commit is contained in:
Thomas Waldmann 2017-04-25 22:21:58 +02:00
parent 6f47b797f9
commit ca6257dd48

View file

@ -2842,7 +2842,20 @@ class Archiver:
help='repository to prune')
upgrade_epilog = process_epilog("""
Upgrade an existing Borg repository.
Upgrade an existing, local Borg repository.
When you do not need borg upgrade
+++++++++++++++++++++++++++++++++
Not every change requires that you run ``borg upgrade``.
You do **not** need to run it when:
- moving your repository to a different place
- upgrading to another point release (like 1.0.x to 1.0.y),
except when noted otherwise in the changelog
- upgrading from 1.0.x to 1.1.x,
except when noted otherwise in the changelog
Borg 1.x.y upgrades
+++++++++++++++++++