Ver código fonte

Move migrate-to-repokey to the "key" command group

Marian Beermann 8 anos atrás
pai
commit
5fe32866e6
4 arquivos alterados com 6 adições e 38 exclusões
  1. 4 0
      docs/changes.rst
  2. 1 1
      docs/usage.rst
  3. 0 36
      docs/usage/migrate-to-repokey.rst.inc
  4. 1 1
      src/borg/archiver.py

+ 4 - 0
docs/changes.rst

@@ -131,6 +131,10 @@ Changelog
 Version 1.1.0b4 (not released yet)
 ----------------------------------
 
+Compatibility notes:
+
+- Moved "borg migrate-to-repokey" to "borg key migrate-to-repokey".
+
 New features:
 
 - the --exclude-if-present option now supports tagging a folder with any

+ 1 - 1
docs/usage.rst

@@ -774,7 +774,7 @@ Thus, to upgrade a "passphrase" attic repo to a "repokey" borg repo, 2 steps
 are needed, in this order:
 
 - borg upgrade repo
-- borg migrate-to-repokey repo
+- borg key migrate-to-repokey repo
 
 
 .. include:: usage/recreate.rst.inc

+ 0 - 36
docs/usage/migrate-to-repokey.rst.inc

@@ -1,36 +0,0 @@
-.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
-
-.. _borg_migrate-to-repokey:
-
-borg migrate-to-repokey
------------------------
-::
-
-    borg migrate-to-repokey <options> REPOSITORY
-
-positional arguments
-    REPOSITORY
-
-
-`Common options`_
-    |
-
-Description
-~~~~~~~~~~~
-
-This command migrates a repository from passphrase mode (not supported any
-more) to repokey mode.
-
-You will be first asked for the repository passphrase (to open it in passphrase
-mode). This is the same passphrase as you used to use for this repo before 1.0.
-
-It will then derive the different secrets from this passphrase.
-
-Then you will be asked for a new passphrase (twice, for safety). This
-passphrase will be used to protect the repokey (which contains these same
-secrets in encrypted form). You may use the same passphrase as you used to
-use, but you may also use a different one.
-
-After migrating to repokey mode, you can change the passphrase at any time.
-But please note: the secrets will always stay the same and they could always
-be derived from your (old) passphrase-mode passphrase.

+ 1 - 1
src/borg/archiver.py

@@ -1904,7 +1904,7 @@ class Archiver:
         But please note: the secrets will always stay the same and they could always
         be derived from your (old) passphrase-mode passphrase.
         """)
-        subparser = subparsers.add_parser('migrate-to-repokey', parents=[common_parser], add_help=False,
+        subparser = key_parsers.add_parser('migrate-to-repokey', parents=[common_parser], add_help=False,
                                           description=self.do_migrate_to_repokey.__doc__,
                                           epilog=migrate_to_repokey_epilog,
                                           formatter_class=argparse.RawDescriptionHelpFormatter,