clarify borg upgrade docs, fixes #2436

(cherry picked from commit ca6257dd48)
This commit is contained in:
Thomas Waldmann 2017-04-25 22:21:58 +02:00
parent b60f42f8f3
commit c8c773bac3
1 changed files with 14 additions and 1 deletions

View File

@ -1764,7 +1764,20 @@ class Archiver:
help='repository to prune') help='repository to prune')
upgrade_epilog = textwrap.dedent(""" upgrade_epilog = textwrap.dedent("""
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 Borg 1.x.y upgrades
+++++++++++++++++++ +++++++++++++++++++