From 5225dbfc4e578ad709e09777ddca89c0221a51ae Mon Sep 17 00:00:00 2001 From: Saurav Sachidanand Date: Sun, 27 May 2018 12:55:18 +0530 Subject: [PATCH] Clarify --append-only flag --- src/borg/archiver.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 256b77d18..64e5e0c4a 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -2488,7 +2488,10 @@ class Archiver: 'PATH may be an empty directory or the last element of PATH may not exist, in which case ' 'the client may initialize a repository there.') subparser.add_argument('--append-only', dest='append_only', action='store_true', - help='only allow appending to repository segment files') + help='only allow appending to repository segment files. Note that this only ' + 'affects the low level structure of the repository, and running `delete` ' + 'or `prune` will still be allowed. See :ref:`append_only_mode` in Additional ' + 'Notes for more details.') subparser.add_argument('--storage-quota', metavar='QUOTA', dest='storage_quota', type=parse_storage_quota, default=None, help='Override storage quota of the repository (e.g. 5G, 1.5T). ' @@ -2610,7 +2613,10 @@ class Archiver: choices=key_argument_names(), help='select encryption key mode **(required)**') subparser.add_argument('--append-only', dest='append_only', action='store_true', - help='create an append-only mode repository') + help='create an append-only mode repository. Note that this only affects ' + 'the low level structure of the repository, and running `delete` ' + 'or `prune` will still be allowed. See :ref:`append_only_mode` in ' + 'Additional Notes for more details.') subparser.add_argument('--storage-quota', metavar='QUOTA', dest='storage_quota', default=None, type=parse_storage_quota, help='Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.')