Ver código fonte

document that passphrase(-only) mode is deprecated

Thomas Waldmann 9 anos atrás
pai
commit
74e5860508
2 arquivos alterados com 10 adições e 3 exclusões
  1. 6 1
      CHANGES.rst
  2. 4 2
      borg/archiver.py

+ 6 - 1
CHANGES.rst

@@ -16,6 +16,11 @@ Incompatible changes (compared to 0.23):
   you accidentially give access permissions for group and/or others to files
   you accidentially give access permissions for group and/or others to files
   created by borg (e.g. the repository).
   created by borg (e.g. the repository).
 
 
+Deprecations:
+
+- "--encryption passphrase" mode is deprecated, see #85 and #97.
+  See the new "--encryption repokey" mode for a replacement.
+
 New features:
 New features:
 
 
 - borg create --chunker-params ... to configure the chunker, fixes #16
 - borg create --chunker-params ... to configure the chunker, fixes #16
@@ -28,7 +33,7 @@ New features:
 - borg create --compression 0..9 to select zlib compression level, fixes #66
 - borg create --compression 0..9 to select zlib compression level, fixes #66
   (attic #295).
   (attic #295).
 - borg init --encryption repokey (to store the encryption key into the repo),
 - borg init --encryption repokey (to store the encryption key into the repo),
-  deprecate --encryption passphrase, fixes #85
+  fixes #85
 - improve at-end error logging, always log exceptions and set exit_code=1
 - improve at-end error logging, always log exceptions and set exit_code=1
 - LoggedIO: better error checks / exceptions / exception handling
 - LoggedIO: better error checks / exceptions / exception handling
 - implement --remote-path to allow non-default-path borg locations, #125
 - implement --remote-path to allow non-default-path borg locations, #125

+ 4 - 2
borg/archiver.py

@@ -537,6 +537,8 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
         This command initializes an empty repository. A repository is a filesystem
         This command initializes an empty repository. A repository is a filesystem
         directory containing the deduplicated data from zero or more archives.
         directory containing the deduplicated data from zero or more archives.
         Encryption can be enabled at repository init time.
         Encryption can be enabled at repository init time.
+        Please note that the 'passphrase' encryption mode is DEPRECATED (instead of it,
+        consider using 'repokey').
         """)
         """)
         subparser = subparsers.add_parser('init', parents=[common_parser],
         subparser = subparsers.add_parser('init', parents=[common_parser],
                                           description=self.do_init.__doc__, epilog=init_epilog,
                                           description=self.do_init.__doc__, epilog=init_epilog,
@@ -546,8 +548,8 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
                                type=location_validator(archive=False),
                                type=location_validator(archive=False),
                                help='repository to create')
                                help='repository to create')
         subparser.add_argument('-e', '--encryption', dest='encryption',
         subparser.add_argument('-e', '--encryption', dest='encryption',
-                               choices=('none', 'passphrase', 'keyfile', 'repokey'), default='none',
-                               help='select encryption method')
+                               choices=('none', 'keyfile', 'repokey', 'passphrase'), default='none',
+                               help='select encryption key mode')
 
 
         check_epilog = textwrap.dedent("""
         check_epilog = textwrap.dedent("""
         The check command verifies the consistency of a repository and the corresponding archives.
         The check command verifies the consistency of a repository and the corresponding archives.