summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@torproject.org>2011-09-07 11:30:58 -0300
committerTomás Touceda <chiiph@torproject.org>2011-09-07 11:30:58 -0300
commit0bdd881ffb8dc1923c1b308e4f8557b4a46393f0 (patch)
tree3c8af47bab72785459db8eed425e7a5dc4a69c14
parent23aa3ccd0dc33e158e8ea1d65cbf055552025d67 (diff)
Adds README, RELEASE-NOTES and ACKS files for lockfile
-rw-r--r--lib/thandy/lockfile/ACKS6
-rw-r--r--lib/thandy/lockfile/README27
-rw-r--r--lib/thandy/lockfile/RELEASE-NOTES50
3 files changed, 83 insertions, 0 deletions
diff --git a/lib/thandy/lockfile/ACKS b/lib/thandy/lockfile/ACKS
new file mode 100644
index 0000000..44519d1
--- /dev/null
+++ b/lib/thandy/lockfile/ACKS
@@ -0,0 +1,6 @@
+Thanks to the following people for help with lockfile.
+
+ Scott Dial
+ Ben Finney
+ Frank Niessink
+ Konstantin Veretennicov
diff --git a/lib/thandy/lockfile/README b/lib/thandy/lockfile/README
new file mode 100644
index 0000000..128b1f3
--- /dev/null
+++ b/lib/thandy/lockfile/README
@@ -0,0 +1,27 @@
+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.
+The lock mechanism relies on the atomic nature of the link (on Unix) and
+mkdir (on Windows) system calls. An implementation based on SQLite is also
+provided, more as a demonstration of the possibilities it provides than as
+production-quality code.
+
+Note: In version 0.9 the API changed in two significant ways:
+
+ * It changed from a module defining several classes to a package containing
+ several modules, each defining a single class.
+
+ * Where classes had been named SomethingFileLock before the last two words
+ have been reversed, so that class is now SomethingLockFile.
+
+The previous module-level definitions of LinkFileLock, MkdirFileLock and
+SQLiteFileLock will be retained until the 1.0 release.
+
+Download from:
+
+ http://code.google.com/p/pylockfile/
+
+To install:
+
+ python setup.py install
diff --git a/lib/thandy/lockfile/RELEASE-NOTES b/lib/thandy/lockfile/RELEASE-NOTES
new file mode 100644
index 0000000..8b452ed
--- /dev/null
+++ b/lib/thandy/lockfile/RELEASE-NOTES
@@ -0,0 +1,50 @@
+Version 0.9.1
+=============
+
+* This release moves the source location to Google Code.
+
+* Threaded support is currently broken. (It might not actually be broken.
+ It might just be the tests which are broken.)
+
+Version 0.9
+===========
+
+* The lockfile module was reorganized into a package.
+
+* The names of the three main classes have changed as follows:
+
+ LinkFileLock -> LinkLockFile
+ MkdirFileLock -> MkdirLockFile
+ SQLiteFileLock -> SQLiteLockFile
+
+* A PIDLockFile class was added.
+
+Version 0.3
+===========
+
+* Fix 2.4.diff file error.
+
+* More documentation updates.
+
+Version 0.2
+===========
+
+* Added 2.4.diff file to patch lockfile to work with Python 2.4 (removes use
+ of with statement).
+
+* Renamed _FileLock base class to LockBase to expose it (and its docstrings)
+ to pydoc.
+
+* Got rid of time.sleep() calls in tests (thanks to Konstantin
+ Veretennicov).
+
+* Use thread.get_ident() as the thread discriminator.
+
+* Updated documentation a bit.
+
+* Added RELEASE-NOTES.
+
+Version 0.1
+===========
+
+* First release - All basic functionality there.