Merge pull request #9506 from ThomasWaldmann/improve-serve-append-only-docs-1.4
Some checks are pending
CI / lint (push) Waiting to run
CI / asan_ubsan (push) Blocked by required conditions
CI / native_tests (push) Blocked by required conditions
CI / vm_tests (Haiku, false, haiku, r1beta5) (push) Blocked by required conditions
CI / vm_tests (NetBSD, false, netbsd, 10.1) (push) Blocked by required conditions
CI / vm_tests (OpenBSD, false, openbsd, 7.7) (push) Blocked by required conditions
CI / vm_tests (borg-freebsd-14-x86_64-gh, FreeBSD, true, freebsd, 14.3) (push) Blocked by required conditions
CodeQL / Analyze (push) Waiting to run
Windows CI / msys2-ucrt64 (push) Waiting to run

clarify append-only != write-only, fixes #9304
This commit is contained in:
TW 2026-03-18 19:52:31 +01:00 committed by GitHub
commit 21353a34c5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 2 deletions

View file

@ -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.

View file

@ -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). '