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

clarify lock_wait docstring

Browse source 
1.1 had some bug due to this, see PR #3981,
changeset 2f3e60d9d5.

the bug does not apply to 1.0, but the improved doc strings might
still be useful.
This commit is contained in:
Thomas Waldmann 2018-07-15 10:46:14 +02:00
parent cc29608917
commit eee3585fbb
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
borg/cache.py
View file

@ -51,6 +51,9 @@ class Cache:
def __init__(self, repository, key, manifest, path=None, sync=True, do_files=False, warn_if_unencrypted=True,
lock_wait=None):
"""
:param lock_wait: timeout for lock acquisition (int [s] or None [wait forever])
"""
self.lock = None
self.timestamp = None
self.lock = None

6
borg/locking.py
View file

@ -26,7 +26,7 @@ def get_id():
class TimeoutTimer:
"""
A timer for timeout checks (can also deal with no timeout, give timeout=None [default]).
A timer for timeout checks (can also deal with "never timeout").
It can also compute and optionally execute a reasonable sleep time (e.g. to avoid
polling too often or to support thread/process rescheduling).
"""
@ -34,10 +34,10 @@ class TimeoutTimer:
"""
Initialize a timer.
:param timeout: time out interval [s] or None (no timeout)
:param timeout: time out interval [s] or None (never timeout, wait forever) [default]
:param sleep: sleep interval [s] (>= 0: do sleep call, <0: don't call sleep)
or None (autocompute: use 10% of timeout [but not more than 60s],
or 1s for no timeout)
or 1s for "never timeout" mode)
"""
if timeout is not None and timeout < 0:
raise ValueError("timeout must be >= 0")