Merge pull request #18 from harlowja/add-nice-links

Add useful link to locking blog
harlowja · Dec 13, 2015 · 95e1cce · 95e1cce
2 parents 4641f5b + 0797b37
commit 95e1cce
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/fasteners/process_lock.py b/fasteners/process_lock.py
@@ -66,6 +66,11 @@ class _InterProcessLock(object):
     safe to close the file descriptor while another thread holds the
     lock. Just opening and closing the lock file can break synchronization,
     so lock files must be accessed only using this abstraction.
+
+    .. warning::
+
+       It is quite useful to read before using (to understand
+       the risks involved): http://0pointer.de/blog/projects/locking.html
     """
 
     MAX_DELAY = 0.1