summaryrefslogtreecommitdiff
path: root/python/lockfile/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/lockfile/README')
-rw-r--r--python/lockfile/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/python/lockfile/README b/python/lockfile/README
new file mode 100644
index 0000000000..fbfc355f8c
--- /dev/null
+++ b/python/lockfile/README
@@ -0,0 +1,8 @@
+The lockfile package exports a LockFile class which provides a simple
+API for locking files.
+
+Unlike the Windows msvcrt.locking function, the fcntl.lockf and flock
+functions, and the deprecated posixfile module, the API is identical
+across both Unix (including Linux and Mac) and Windows platforms.
+
+This package is version 0.8 due to some API breakage in 0.9+