From 4efaaca75187d5d60046a6e41e89505c5c9e9bd2 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Wed, 18 Mar 2026 19:11:35 +0100 Subject: [PATCH] clarify append-only != write-only, fixes #9304 --- docs/usage/notes.rst | 4 ++++ src/borg/archiver.py | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/usage/notes.rst b/docs/usage/notes.rst index d4fadb8fa..dda20cc0f 100644 --- a/docs/usage/notes.rst +++ b/docs/usage/notes.rst @@ -208,6 +208,10 @@ A repository can be made "append-only", which means that Borg will never overwrite or delete committed data (append-only refers to the segment files, but borg will also reject to delete the repository completely). +Please note that this only affects the low level structure of the repository, +and running ``borg delete`` or `borg prune` or reading from the repository will +still be allowed. + If ``borg compact`` command is used on a repo in append-only mode, there will be no warning or error, but no compaction will happen. diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 40a27125c..aaca200d1 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -5251,8 +5251,8 @@ class Archiver: subparser.add_argument('--append-only', dest='append_only', action='store_true', 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.') + 'or `prune` or reading from the repository 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). '