From fcdf88d43eae3afdee389e7dc869e8d6458d8bbe Mon Sep 17 00:00:00 2001 From: Fabio Mascarenhas Date: Thu, 9 Jun 2011 18:11:38 -0300 Subject: [PATCH] fix documentation for lock_dir --- manual.html | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/manual.html b/manual.html index 217c249..aa51b73 100644 --- a/manual.html +++ b/manual.html @@ -172,14 +172,12 @@ LuaFileSystem offers the following functions: Returns true in case of success or nil plus an error string. -
lfs.lock_dir(path, [seconds_stale])
+
lfs.lock_dir(path)
Creates a lockfile (called lockfile.lfs) in path if it does not - exist and returns the lock. If the lock already exists checks it - it's stale, using the second parameter (default for the second - parameter is INT_MAX, which in practice means the lock will never - be stale. To free the the lock call lock:free().
+ exist and returns the lock. + To free the the lock call lock:free().
In case of any errors it returns nil and the error message. In - particular, if the lock exists and is not stale it returns the + particular, if the lock exists it returns the "File exists" message.
lfs.currentdir ()