Przeglądaj źródła

clarify borg upgrade docs, fixes #2436

Thomas Waldmann 8 lat temu
rodzic
commit
ca6257dd48
1 zmienionych plików z 14 dodań i 1 usunięć
  1. 14 1
      src/borg/archiver.py

+ 14 - 1
src/borg/archiver.py

@@ -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
         +++++++++++++++++++