1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-15 00:21:56 +00:00

Capitalization fixes for upgrade help epilog

This commit is contained in:
Michael Hanselmann 2016-01-14 17:00:45 +01:00
parent 89169c3f87
commit b6d0ee7c13

View file

@ -1112,41 +1112,41 @@ class Archiver:
help='repository to prune') help='repository to prune')
upgrade_epilog = textwrap.dedent(""" upgrade_epilog = textwrap.dedent("""
upgrade an existing Borg repository. this currently Upgrade an existing Borg repository. This currently
only support converting an Attic repository, but may only supports converting an Attic repository, but may
eventually be extended to cover major Borg upgrades as well. eventually be extended to cover major Borg upgrades as well.
it will change the magic strings in the repository's segments It will change the magic strings in the repository's segments
to match the new Borg magic strings. the keyfiles found in to match the new Borg magic strings. The keyfiles found in
$ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
copied to $BORG_KEYS_DIR or ~/.borg/keys. copied to $BORG_KEYS_DIR or ~/.borg/keys.
the cache files are converted, from $ATTIC_CACHE_DIR or The cache files are converted, from $ATTIC_CACHE_DIR or
~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the ~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
cache layout between Borg and Attic changed, so it is possible cache layout between Borg and Attic changed, so it is possible
the first backup after the conversion takes longer than expected the first backup after the conversion takes longer than expected
due to the cache resync. due to the cache resync.
upgrade should be able to resume if interrupted, although it Upgrade should be able to resume if interrupted, although it
will still iterate over all segments. if you want to start will still iterate over all segments. If you want to start
from scratch, use `borg delete` over the copied repository to from scratch, use `borg delete` over the copied repository to
make sure the cache files are also removed: make sure the cache files are also removed:
borg delete borg borg delete borg
unless ``--inplace`` is specified, the upgrade process first Unless ``--inplace`` is specified, the upgrade process first
creates a backup copy of the repository, in creates a backup copy of the repository, in
REPOSITORY.upgrade-DATETIME, using hardlinks. this takes REPOSITORY.upgrade-DATETIME, using hardlinks. This takes
longer than in place upgrades, but is much safer and gives longer than in place upgrades, but is much safer and gives
progress information (as opposed to ``cp -al``). once you are progress information (as opposed to ``cp -al``). Once you are
satisfied with the conversion, you can safely destroy the satisfied with the conversion, you can safely destroy the
backup copy. backup copy.
WARNING: running the upgrade in place will make the current WARNING: Running the upgrade in place will make the current
copy unusable with older version, with no way of going back copy unusable with older version, with no way of going back
to previous versions. this can PERMANENTLY DAMAGE YOUR to previous versions. This can PERMANENTLY DAMAGE YOUR
REPOSITORY! Attic CAN NOT READ BORG REPOSITORIES, as the REPOSITORY! Attic CAN NOT READ BORG REPOSITORIES, as the
magic strings have changed. you have been warned.""") magic strings have changed. You have been warned.""")
subparser = subparsers.add_parser('upgrade', parents=[common_parser], subparser = subparsers.add_parser('upgrade', parents=[common_parser],
description=self.do_upgrade.__doc__, description=self.do_upgrade.__doc__,
epilog=upgrade_epilog, epilog=upgrade_epilog,