From b6d0ee7c13f1054bdbb7faa1cdf77221e122c6cb Mon Sep 17 00:00:00 2001 From: Michael Hanselmann Date: Thu, 14 Jan 2016 17:00:45 +0100 Subject: [PATCH] Capitalization fixes for upgrade help epilog --- borg/archiver.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/borg/archiver.py b/borg/archiver.py index f3abe8f43..3c09840cd 100644 --- a/borg/archiver.py +++ b/borg/archiver.py @@ -1112,41 +1112,41 @@ class Archiver: help='repository to prune') upgrade_epilog = textwrap.dedent(""" - upgrade an existing Borg repository. this currently - only support converting an Attic repository, but may + Upgrade an existing Borg repository. This currently + only supports converting an Attic repository, but may eventually be extended to cover major Borg upgrades as well. - it will change the magic strings in the repository's segments - to match the new Borg magic strings. the keyfiles found in + It will change the magic strings in the repository's segments + to match the new Borg magic strings. The keyfiles found in $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and 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 layout between Borg and Attic changed, so it is possible the first backup after the conversion takes longer than expected due to the cache resync. - upgrade should be able to resume if interrupted, although it - will still iterate over all segments. if you want to start + Upgrade should be able to resume if interrupted, although it + will still iterate over all segments. If you want to start from scratch, use `borg delete` over the copied repository to make sure the cache files are also removed: 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 - 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 - 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 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 - 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 - magic strings have changed. you have been warned.""") + magic strings have changed. You have been warned.""") subparser = subparsers.add_parser('upgrade', parents=[common_parser], description=self.do_upgrade.__doc__, epilog=upgrade_epilog,