Browse Source

merged 1.0-maint into master

Thomas Waldmann 9 years ago
parent
commit
cece7f9e6d

+ 1 - 1
borg/archive.py

@@ -917,7 +917,7 @@ class ArchiveChecker:
                 for id_ in unused:
                     self.repository.delete(id_)
         else:
-            logger.warning('Orphaned objects check skipped (needs all archives checked).')
+            logger.info('Orphaned objects check skipped (needs all archives checked).')
 
     def finish(self, save_space=False):
         if self.repair:

+ 12 - 4
borg/archiver.py

@@ -704,7 +704,6 @@ class Archiver:
         """List archive or repository contents"""
         if args.location.archive:
             matcher, _ = self.build_matcher(args.excludes, args.paths)
-
             with Cache(repository, key, manifest, lock_wait=self.lock_wait) as cache:
                 archive = Archive(repository, key, manifest, args.location.archive, cache=cache)
 
@@ -1016,12 +1015,21 @@ class Archiver:
 
     def build_parser(self, args=None, prog=None):
         common_parser = argparse.ArgumentParser(add_help=False, prog=prog)
-        common_parser.add_argument('-v', '--verbose', '--info', dest='log_level',
+        common_parser.add_argument('--critical', dest='log_level',
+                                   action='store_const', const='critical', default='warning',
+                                   help='work on log level CRITICAL')
+        common_parser.add_argument('--error', dest='log_level',
+                                   action='store_const', const='error', default='warning',
+                                   help='work on log level ERROR')
+        common_parser.add_argument('--warning', dest='log_level',
+                                   action='store_const', const='warning', default='warning',
+                                   help='work on log level WARNING (default)')
+        common_parser.add_argument('--info', '-v', '--verbose', dest='log_level',
                                    action='store_const', const='info', default='warning',
-                                   help='enable informative (verbose) output, work on log level INFO')
+                                   help='work on log level INFO')
         common_parser.add_argument('--debug', dest='log_level',
                                    action='store_const', const='debug', default='warning',
-                                   help='enable debug output, work on log level DEBUG')
+                                   help='work on log level DEBUG')
         common_parser.add_argument('--lock-wait', dest='lock_wait', type=int, metavar='N', default=1,
                                    help='wait for the lock, but max. N seconds (default: %(default)d).')
         common_parser.add_argument('--show-version', dest='show_version', action='store_true', default=False,

+ 16 - 6
borg/key.py

@@ -18,6 +18,10 @@ import msgpack
 PREFIX = b'\0' * 8
 
 
+class PassphraseWrong(Error):
+    """passphrase supplied in BORG_PASSPHRASE is incorrect"""
+
+
 class PasswordRetriesExceeded(Error):
     """exceeded the maximum password retries"""
 
@@ -285,13 +289,19 @@ class KeyfileKeyBase(AESKeyBase):
         key = cls(repository)
         target = key.find_key()
         prompt = 'Enter passphrase for key %s: ' % target
-        passphrase = Passphrase.env_passphrase(default='')
-        for retry in range(1, 4):
-            if key.load(target, passphrase):
-                break
-            passphrase = Passphrase.getpass(prompt)
+        passphrase = Passphrase.env_passphrase()
+        if passphrase is None:
+            passphrase = Passphrase()
+            if not key.load(target, passphrase):
+                for retry in range(0, 3):
+                    passphrase = Passphrase.getpass(prompt)
+                    if key.load(target, passphrase):
+                        break
+                else:
+                    raise PasswordRetriesExceeded
         else:
-            raise PasswordRetriesExceeded
+            if not key.load(target, passphrase):
+                raise PassphraseWrong
         num_blocks = num_aes_blocks(len(manifest_data) - 41)
         key.init_ciphers(PREFIX + long_to_bytes(key.extract_nonce(manifest_data) + num_blocks))
         return key

+ 16 - 3
borg/remote.py

@@ -82,6 +82,7 @@ class RepositoryServer:  # pragma: no cover
                 unpacker.feed(data)
                 for unpacked in unpacker:
                     if not (isinstance(unpacked, tuple) and len(unpacked) == 4):
+                        self.repository.close()
                         raise Exception("Unexpected RPC data format.")
                     type, msgid, method, args = unpacked
                     method = method.decode('ascii')
@@ -94,8 +95,12 @@ class RepositoryServer:  # pragma: no cover
                             f = getattr(self.repository, method)
                         res = f(*args)
                     except BaseException as e:
-                        logging.exception('Borg %s: exception in RPC call:', __version__)
-                        logging.error(sysinfo())
+                        # These exceptions are reconstructed on the client end in RemoteRepository.call_many(),
+                        # and will be handled just like locally raised exceptions. Suppress the remote traceback
+                        # for these, except ErrorWithTraceback, which should always display a traceback.
+                        if not isinstance(e, (Repository.DoesNotExist, Repository.AlreadyExists, PathNotAllowed)):
+                            logging.exception('Borg %s: exception in RPC call:', __version__)
+                            logging.error(sysinfo())
                         exc = "Remote Exception (see remote log for the traceback)"
                         os.write(stdout_fd, msgpack.packb((1, msgid, e.__class__.__name__, exc)))
                     else:
@@ -164,7 +169,11 @@ class RemoteRepository:
             raise ConnectionClosedWithHint('Is borg working on the server?') from None
         if version != RPC_PROTOCOL_VERSION:
             raise Exception('Server insisted on using unsupported protocol version %d' % version)
-        self.id = self.call('open', location.path, create, lock_wait, lock)
+        try:
+            self.id = self.call('open', self.location.path, create, lock_wait, lock)
+        except Exception:
+            self.close()
+            raise
 
     def __del__(self):
         if self.p:
@@ -195,6 +204,10 @@ class RemoteRepository:
                 opts.append('--info')
             elif root_logger.isEnabledFor(logging.WARNING):
                 pass  # warning is default
+            elif root_logger.isEnabledFor(logging.ERROR):
+                opts.append('--error')
+            elif root_logger.isEnabledFor(logging.CRITICAL):
+                opts.append('--critical')
             else:
                 raise ValueError('log level missing, fix this code')
         if testing:

+ 1 - 1
borg/testsuite/archiver.py

@@ -60,6 +60,7 @@ def exec_cmd(*args, archiver=None, fork=False, exe=None, **kw):
             sys.stdout = sys.stderr = output = StringIO()
             if archiver is None:
                 archiver = Archiver()
+            archiver.exit_code = EXIT_SUCCESS
             args = archiver.parse_args(list(args))
             ret = archiver.run(args)
             return ret, output.getvalue()
@@ -790,7 +791,6 @@ class ArchiverTestCase(ArchiverTestCaseBase):
         self.cmd('create', self.repository_location + '::test.2', 'input')
         os.environ['BORG_DELETE_I_KNOW_WHAT_I_AM_DOING'] = 'no'
         self.cmd('delete', self.repository_location, exit_code=2)
-        self.archiver.exit_code = 0
         assert os.path.exists(self.repository_path)
         os.environ['BORG_DELETE_I_KNOW_WHAT_I_AM_DOING'] = 'YES'
         self.cmd('delete', self.repository_location)

+ 23 - 23
docs/api.rst

@@ -2,94 +2,94 @@
 API Documentation
 =================
 
-.. automodule:: borg.xattr
+.. automodule:: borg.platform
     :members:
     :undoc-members:
 
-.. automodule:: borg.hash_sizes
+.. automodule:: borg.shellpattern
     :members:
     :undoc-members:
 
-.. automodule:: borg.archive
+.. automodule:: borg.locking
     :members:
     :undoc-members:
 
-.. automodule:: borg.repository
+.. automodule:: borg.hash_sizes
     :members:
     :undoc-members:
 
-.. automodule:: borg.platform
+.. automodule:: borg.logger
     :members:
     :undoc-members:
 
-.. automodule:: borg.cache
+.. automodule:: borg.remote
     :members:
     :undoc-members:
 
-.. automodule:: borg.helpers
+.. automodule:: borg.fuse
     :members:
     :undoc-members:
 
-.. automodule:: borg.lrucache
+.. automodule:: borg.archive
     :members:
     :undoc-members:
 
-.. automodule:: borg.key
+.. automodule:: borg.helpers
     :members:
     :undoc-members:
 
-.. automodule:: borg.upgrader
+.. automodule:: borg.lrucache
     :members:
     :undoc-members:
 
-.. automodule:: borg.shellpattern
+.. automodule:: borg.xattr
     :members:
     :undoc-members:
 
-.. automodule:: borg.locking
+.. automodule:: borg.archiver
     :members:
     :undoc-members:
 
-.. automodule:: borg.fuse
+.. automodule:: borg.repository
     :members:
     :undoc-members:
 
-.. automodule:: borg.logger
+.. automodule:: borg.cache
     :members:
     :undoc-members:
 
-.. automodule:: borg.archiver
+.. automodule:: borg.key
     :members:
     :undoc-members:
 
-.. automodule:: borg.remote
+.. automodule:: borg.upgrader
     :members:
     :undoc-members:
 
-.. automodule:: borg.chunker
+.. automodule:: borg.platform_darwin
     :members:
     :undoc-members:
 
-.. automodule:: borg.platform_freebsd
+.. automodule:: borg.compress
     :members:
     :undoc-members:
 
-.. automodule:: borg.hashindex
+.. automodule:: borg.platform_linux
     :members:
     :undoc-members:
 
-.. automodule:: borg.compress
+.. automodule:: borg.crypto
     :members:
     :undoc-members:
 
-.. automodule:: borg.platform_linux
+.. automodule:: borg.chunker
     :members:
     :undoc-members:
 
-.. automodule:: borg.crypto
+.. automodule:: borg.platform_freebsd
     :members:
     :undoc-members:
 
-.. automodule:: borg.platform_darwin
+.. automodule:: borg.hashindex
     :members:
     :undoc-members:

+ 31 - 16
docs/changes.rst

@@ -1,40 +1,55 @@
 Changelog
 =========
 
-Version 1.0.1 (not released yet)
---------------------------------
+Version 1.0.1
+-------------
 
 New features:
 
-Usually there are no new features in a bugfix release, but these 2 were added
-to get them out quickly - as both positively affect your safety/security:
-
-- append-only mode for repositories, #809, #36
-  (please read the docs about how this can improve your security)
-- implement password roundtrip, #695 (make sure the user can know/verify the
-  encryption key password/passphrase, to avoid double-typos, wrong keyboard
-  layout or locale/encoding issues)
+Usually there are no new features in a bugfix release, but these were added
+due to their high impact on security/safety/speed or because they are fixes
+also:
+
+- append-only mode for repositories, #809, #36 (see docs)
+- borg create: add --ignore-inode option to make borg detect unmodified files
+  even if your filesystem does not have stable inode numbers (like sshfs and
+  possibly CIFS).
+- add options --warning, --error, --critical for missing log levels, #826.
+  it's not recommended to suppress warnings or errors, but the user may decide
+  this on his own.
+  note: --warning is not given to borg serve so a <= 1.0.0 borg will still
+  work as server (it is not needed as it is the default).
+  do not use --error or --critical when using a <= 1.0.0 borg server.
 
 Bug fixes:
 
 - fix silently skipping EIO, #748
-- do not sleep for >60s while waiting for lock, fixes #773
+- add context manager for Repository (avoid orphan repository locks), #285
+- do not sleep for >60s while waiting for lock, #773
 - unpack file stats before passing to FUSE
 - fix build on illumos
 - don't try to backup doors or event ports (Solaris and derivates)
-- fix capitalization, add ellipses, change log level to debug for 2 messages, fixes #798
-- remove useless/misleading libc version display, fixes #738
+- remove useless/misleading libc version display, #738
+- test suite: reset exit code of persistent archiver, #844
+- RemoteRepository: clean up pipe if remote open() fails
+- Remote: don't print tracebacks for Error exceptions handled downstream, #792
+- if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
+  instead, #791
+- ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
+- fix capitalization, add ellipses, change log level to debug for 2 messages,
+  #798
 
 Other changes:
 
 - update llfuse requirement, llfuse 1.0 works
-- update OS / dist packages on build machines, fixes #717
+- update OS / dist packages on build machines, #717
+- prefer showing --info over -v in usage help, #859
 - docs:
 
   - fix cygwin requirements (gcc-g++)
-  - document how to debug / file filesystem issues, fixes #664
+  - document how to debug / file filesystem issues, #664
   - fix reproducible build of api docs
-  - RTD theme: CSS !important overwrite. Fix borgbackup/borg#727
+  - RTD theme: CSS !important overwrite, #727
   - Document logo font. Recreate logo png. Remove GIMP logo file.
 
 

+ 18 - 6
docs/usage.rst

@@ -16,19 +16,31 @@ Type of log output
 
 The log level of the builtin logging configuration defaults to WARNING.
 This is because we want |project_name| to be mostly silent and only output
-warnings (plus errors and critical messages).
+warnings, errors and critical messages.
 
-Use ``--verbose`` or ``--info`` to set INFO (you will get informative output then
-additionally to warnings, errors, critical messages).
-Use ``--debug`` to set DEBUG to get output made for debugging.
+Log levels: DEBUG < INFO < WARNING < ERROR < CRITICAL
 
-All log messages created with at least the set level will be output.
+Use ``--debug`` to set DEBUG log level -
+to get debug, info, warning, error and critical level output.
 
-Log levels: DEBUG < INFO < WARNING < ERROR < CRITICAL
+Use ``--info`` (or ``-v`` or ``--verbose``) to set INFO log level -
+to get info, warning, error and critical level output.
+
+Use ``--warning`` (default) to set WARNING log level -
+to get warning, error and critical level output.
+
+Use ``--error`` to set ERROR log level -
+to get error and critical level output.
+
+Use ``--critical`` to set CRITICAL log level -
+to get critical level output.
 
 While you can set misc. log levels, do not expect that every command will
 give different output on different log levels - it's just a possibility.
 
+.. warning:: Options --critical and --error are provided for completeness,
+             their usage is not recommended as you might miss important information.
+
 .. warning:: While some options (like ``--stats`` or ``--list``) will emit more
              informational messages, you have to use INFO (or lower) log level to make
              them show up in log output. Use ``-v`` or a logging configuration.

+ 9 - 7
docs/usage/break-lock.rst.inc

@@ -4,9 +4,9 @@ borg break-lock
 ---------------
 ::
 
-    usage: borg break-lock [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                           [--show-rc] [--no-files-cache] [--umask M]
-                           [--remote-path PATH]
+    usage: borg break-lock [-h] [--critical] [--error] [--warning] [--info]
+                           [--debug] [--lock-wait N] [--show-version] [--show-rc]
+                           [--no-files-cache] [--umask M] [--remote-path PATH]
                            REPOSITORY
     
     Break the repository lock (e.g. in case it was left by a dead borg.
@@ -16,10 +16,12 @@ borg break-lock
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/change-passphrase.rst.inc

@@ -4,9 +4,10 @@ borg change-passphrase
 ----------------------
 ::
 
-    usage: borg change-passphrase [-h] [-v] [--debug] [--lock-wait N]
-                                  [--show-version] [--show-rc] [--no-files-cache]
-                                  [--umask M] [--remote-path PATH]
+    usage: borg change-passphrase [-h] [--critical] [--error] [--warning] [--info]
+                                  [--debug] [--lock-wait N] [--show-version]
+                                  [--show-rc] [--no-files-cache] [--umask M]
+                                  [--remote-path PATH]
                                   [REPOSITORY]
     
     Change repository key file passphrase
@@ -16,10 +17,12 @@ borg change-passphrase
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 11 - 8
docs/usage/check.rst.inc

@@ -4,10 +4,11 @@ borg check
 ----------
 ::
 
-    usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                      [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [--repository-only] [--archives-only]
-                      [--repair] [--save-space] [--last N] [-P PREFIX]
+    usage: borg check [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                      [--lock-wait N] [--show-version] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH]
+                      [--repository-only] [--archives-only] [--repair]
+                      [--save-space] [--last N] [-P PREFIX]
                       [REPOSITORY_OR_ARCHIVE]
     
     Check repository consistency
@@ -18,10 +19,12 @@ borg check
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 8
docs/usage/comment.rst.inc

@@ -4,23 +4,25 @@ borg comment
 ------------
 ::
 
-    usage: borg comment [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                        [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH]
+    usage: borg comment [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                        [--lock-wait N] [--show-version] [--show-rc]
+                        [--no-files-cache] [--umask M] [--remote-path PATH]
                         ARCHIVE COMMENT
     
     Set the archive comment
     
     positional arguments:
-      ARCHIVE               archive to rename
+      ARCHIVE               archive to modify
       COMMENT               the new archive comment
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/create.rst.inc

@@ -4,9 +4,10 @@ borg create
 -----------
 ::
 
-    usage: borg create [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                       [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH] [--comment COMMENT] [-s] [-p] [--list]
+    usage: borg create [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                       [--lock-wait N] [--show-version] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH]
+                       [--comment COMMENT] [-s] [-p] [--list]
                        [--filter STATUSCHARS] [-e PATTERN]
                        [--exclude-from EXCLUDEFILE] [--exclude-caches]
                        [--exclude-if-present FILENAME] [--keep-tag-files]
@@ -25,10 +26,12 @@ borg create
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/debug-delete-obj.rst.inc

@@ -4,9 +4,10 @@ borg debug-delete-obj
 ---------------------
 ::
 
-    usage: borg debug-delete-obj [-h] [-v] [--debug] [--lock-wait N]
-                                 [--show-version] [--show-rc] [--no-files-cache]
-                                 [--umask M] [--remote-path PATH]
+    usage: borg debug-delete-obj [-h] [--critical] [--error] [--warning] [--info]
+                                 [--debug] [--lock-wait N] [--show-version]
+                                 [--show-rc] [--no-files-cache] [--umask M]
+                                 [--remote-path PATH]
                                  [REPOSITORY] IDs [IDs ...]
     
     delete the objects with the given IDs from the repo
@@ -17,10 +18,12 @@ borg debug-delete-obj
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 8 - 5
docs/usage/debug-dump-archive-items.rst.inc

@@ -4,7 +4,8 @@ borg debug-dump-archive-items
 -----------------------------
 ::
 
-    usage: borg debug-dump-archive-items [-h] [-v] [--debug] [--lock-wait N]
+    usage: borg debug-dump-archive-items [-h] [--critical] [--error] [--warning]
+                                         [--info] [--debug] [--lock-wait N]
                                          [--show-version] [--show-rc]
                                          [--no-files-cache] [--umask M]
                                          [--remote-path PATH]
@@ -17,10 +18,12 @@ borg debug-dump-archive-items
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 8 - 5
docs/usage/debug-get-obj.rst.inc

@@ -4,7 +4,8 @@ borg debug-get-obj
 ------------------
 ::
 
-    usage: borg debug-get-obj [-h] [-v] [--debug] [--lock-wait N] [--show-version]
+    usage: borg debug-get-obj [-h] [--critical] [--error] [--warning] [--info]
+                              [--debug] [--lock-wait N] [--show-version]
                               [--show-rc] [--no-files-cache] [--umask M]
                               [--remote-path PATH]
                               [REPOSITORY] ID PATH
@@ -18,10 +19,12 @@ borg debug-get-obj
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 8 - 5
docs/usage/debug-put-obj.rst.inc

@@ -4,7 +4,8 @@ borg debug-put-obj
 ------------------
 ::
 
-    usage: borg debug-put-obj [-h] [-v] [--debug] [--lock-wait N] [--show-version]
+    usage: borg debug-put-obj [-h] [--critical] [--error] [--warning] [--info]
+                              [--debug] [--lock-wait N] [--show-version]
                               [--show-rc] [--no-files-cache] [--umask M]
                               [--remote-path PATH]
                               [REPOSITORY] PATH [PATH ...]
@@ -17,10 +18,12 @@ borg debug-put-obj
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/delete.rst.inc

@@ -4,9 +4,10 @@ borg delete
 -----------
 ::
 
-    usage: borg delete [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                       [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH] [-p] [-s] [-c] [--save-space]
+    usage: borg delete [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                       [--lock-wait N] [--show-version] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH] [-p]
+                       [-s] [-c] [--save-space]
                        [TARGET]
     
     Delete an existing repository or archive
@@ -16,10 +17,12 @@ borg delete
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 8
docs/usage/diff.rst.inc

@@ -4,10 +4,10 @@ borg diff
 ---------
 ::
 
-    usage: borg diff [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                     [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH] [-e PATTERN]
-                     [--exclude-from EXCLUDEFILE] [--numeric-owner]
+    usage: borg diff [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                     [--lock-wait N] [--show-version] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH]
+                     [-e PATTERN] [--exclude-from EXCLUDEFILE] [--numeric-owner]
                      [--same-chunker-params] [--sort]
                      ARCHIVE1 ARCHIVE2 [PATH [PATH ...]]
     
@@ -21,10 +21,12 @@ borg diff
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 12 - 9
docs/usage/extract.rst.inc

@@ -4,11 +4,12 @@ borg extract
 ------------
 ::
 
-    usage: borg extract [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                        [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH] [--list] [-n] [-e PATTERN]
-                        [--exclude-from EXCLUDEFILE] [--numeric-owner]
-                        [--strip-components NUMBER] [--stdout] [--sparse]
+    usage: borg extract [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                        [--lock-wait N] [--show-version] [--show-rc]
+                        [--no-files-cache] [--umask M] [--remote-path PATH]
+                        [--list] [-n] [-e PATTERN] [--exclude-from EXCLUDEFILE]
+                        [--numeric-owner] [--strip-components NUMBER] [--stdout]
+                        [--sparse]
                         ARCHIVE [PATH [PATH ...]]
     
     Extract archive contents
@@ -19,10 +20,12 @@ borg extract
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 9 - 7
docs/usage/info.rst.inc

@@ -4,9 +4,9 @@ borg info
 ---------
 ::
 
-    usage: borg info [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                     [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH]
+    usage: borg info [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                     [--lock-wait N] [--show-version] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH]
                      ARCHIVE
     
     Show archive details such as disk space used
@@ -16,10 +16,12 @@ borg info
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/init.rst.inc

@@ -4,9 +4,10 @@ borg init
 ---------
 ::
 
-    usage: borg init [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                     [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH] [-e {none,keyfile,repokey}]
+    usage: borg init [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                     [--lock-wait N] [--show-version] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH]
+                     [-e {none,keyfile,repokey}]
                      [REPOSITORY]
     
     Initialize an empty repository
@@ -16,10 +17,12 @@ borg init
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 11 - 8
docs/usage/list.rst.inc

@@ -4,10 +4,11 @@ borg list
 ---------
 ::
 
-    usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                     [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH] [--short] [--format FORMAT] [-P PREFIX]
-                     [-e PATTERN] [--exclude-from EXCLUDEFILE]
+    usage: borg list [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                     [--lock-wait N] [--show-version] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH] [--short]
+                     [--format FORMAT] [-P PREFIX] [-e PATTERN]
+                     [--exclude-from EXCLUDEFILE]
                      [REPOSITORY_OR_ARCHIVE] [PATH [PATH ...]]
     
     List archive or repository contents
@@ -19,10 +20,12 @@ borg list
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 8 - 5
docs/usage/migrate-to-repokey.rst.inc

@@ -4,7 +4,8 @@ borg migrate-to-repokey
 -----------------------
 ::
 
-    usage: borg migrate-to-repokey [-h] [-v] [--debug] [--lock-wait N]
+    usage: borg migrate-to-repokey [-h] [--critical] [--error] [--warning]
+                                   [--info] [--debug] [--lock-wait N]
                                    [--show-version] [--show-rc] [--no-files-cache]
                                    [--umask M] [--remote-path PATH]
                                    [REPOSITORY]
@@ -16,10 +17,12 @@ borg migrate-to-repokey
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/mount.rst.inc

@@ -4,9 +4,10 @@ borg mount
 ----------
 ::
 
-    usage: borg mount [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                      [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [-f] [-o OPTIONS]
+    usage: borg mount [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                      [--lock-wait N] [--show-version] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH] [-f]
+                      [-o OPTIONS]
                       REPOSITORY_OR_ARCHIVE MOUNTPOINT
     
     Mount archive or an entire repository as a FUSE fileystem
@@ -18,10 +19,12 @@ borg mount
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 12 - 9
docs/usage/prune.rst.inc

@@ -4,11 +4,12 @@ borg prune
 ----------
 ::
 
-    usage: borg prune [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                      [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [-n] [-s] [--list]
-                      [--keep-within WITHIN] [-H HOURLY] [-d DAILY] [-w WEEKLY]
-                      [-m MONTHLY] [-y YEARLY] [-P PREFIX] [--save-space]
+    usage: borg prune [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                      [--lock-wait N] [--show-version] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
+                      [-s] [--list] [--keep-within WITHIN] [-H HOURLY] [-d DAILY]
+                      [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-P PREFIX]
+                      [--save-space]
                       [REPOSITORY]
     
     Prune repository archives according to specified rules
@@ -18,10 +19,12 @@ borg prune
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 9 - 7
docs/usage/rename.rst.inc

@@ -4,9 +4,9 @@ borg rename
 -----------
 ::
 
-    usage: borg rename [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                       [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH]
+    usage: borg rename [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                       [--lock-wait N] [--show-version] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH]
                        ARCHIVE NEWNAME
     
     Rename an existing archive
@@ -17,10 +17,12 @@ borg rename
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/serve.rst.inc

@@ -4,19 +4,22 @@ borg serve
 ----------
 ::
 
-    usage: borg serve [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                      [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [--restrict-to-path PATH]
+    usage: borg serve [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                      [--lock-wait N] [--show-version] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH]
+                      [--restrict-to-path PATH]
     
     Start in server mode. This command is usually not used manually.
             
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)

+ 10 - 7
docs/usage/upgrade.rst.inc

@@ -4,9 +4,10 @@ borg upgrade
 ------------
 ::
 
-    usage: borg upgrade [-h] [-v] [--debug] [--lock-wait N] [--show-version]
-                        [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH] [-p] [-n] [-i]
+    usage: borg upgrade [-h] [--critical] [--error] [--warning] [--info] [--debug]
+                        [--lock-wait N] [--show-version] [--show-rc]
+                        [--no-files-cache] [--umask M] [--remote-path PATH] [-p]
+                        [-n] [-i]
                         [REPOSITORY]
     
     upgrade a repository from a previous version
@@ -16,10 +17,12 @@ borg upgrade
     
     optional arguments:
       -h, --help            show this help message and exit
-      -v, --verbose, --info
-                            enable informative (verbose) output, work on log level
-                            INFO
-      --debug               enable debug output, work on log level DEBUG
+      --critical            work on log level CRITICAL
+      --error               work on log level ERROR
+      --warning             work on log level WARNING (default)
+      --info, -v, --verbose
+                            work on log level INFO
+      --debug               work on log level DEBUG
       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-version        show/log the borg version
       --show-rc             show/log the return code (rc)