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

Merge pull request #4369 from ThomasWaldmann/lock-wait-docstring-1.0

Browse source 
clarify lock_wait docstring
This commit is contained in:
TW 2019-02-15 09:09:29 +01:00 committed by GitHub
commit 3950786f01
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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")