upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-06-10 01:10:53 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: clarify storage quota run-time settings (fixes #3948)

Browse source
This commit is contained in:
Thomas Waldmann 2026-05-13 01:22:03 +02:00
parent bc7814a677
commit 7f4ebba21a
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
3 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/internals/data-structures.rst
View file

@ -237,7 +237,7 @@ Storage quotas
~~~~~~~~~~~~~~
Quotas are implemented at the Repository level. The active quota of a repository
is determined by the ``storage_quota`` `config` entry or a run-time override (via :ref:`borg_serve`).
is determined by the ``storage_quota`` `config` entry or a run-time setting (via :ref:`borg_serve`, which has priority over the config entry).
The currently used quota is stored in the hints file. Operations (PUT and DELETE) during
a transaction modify the currently used quota:

3
docs/usage/config.rst
View file

@ -19,4 +19,7 @@ Examples
# make a repo append-only
$ borg config /path/to/repo append_only 1
# set storage quota to 50 GB
$ borg config /path/to/repo storage_quota 50G

3
src/borg/archiver.py
View file

@ -5265,7 +5265,8 @@ class Archiver:
'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). '
help='Set storage quota of the repository (has priority over the '
'repository\'s own quota setting) (e.g. 5G, 1.5T). '
'When a new repository is initialized, sets the storage quota on the new '
'repository as well. Default: no quota.')