From c8c773bac3e67f8597ac518b487f00e40d95b308 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 25 Apr 2017 22:21:58 +0200 Subject: [PATCH] clarify borg upgrade docs, fixes #2436 (cherry picked from commit ca6257dd4824a3367e129b722d0487716fff951e) --- borg/archiver.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/borg/archiver.py b/borg/archiver.py index 15e7630c7..d555081c9 100644 --- a/borg/archiver.py +++ b/borg/archiver.py @@ -1764,7 +1764,20 @@ class Archiver: help='repository to prune') 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 +++++++++++++++++++