diff options
author | Fabio Mascarenhas <mascarenhas@acm.org> | 2011-06-09 18:11:38 -0300 |
---|---|---|
committer | Fabio Mascarenhas <mascarenhas@acm.org> | 2011-06-09 18:11:38 -0300 |
commit | fcdf88d43eae3afdee389e7dc869e8d6458d8bbe (patch) | |
tree | 53ce67d486a4758d24b5f940ef1b535622b02760 | |
parent | 4d8bc7eb62d9de68589ccd36f73afbd05054ab6f (diff) | |
download | luafilesystem-fcdf88d43eae3afdee389e7dc869e8d6458d8bbe.tar.gz luafilesystem-fcdf88d43eae3afdee389e7dc869e8d6458d8bbe.tar.bz2 luafilesystem-fcdf88d43eae3afdee389e7dc869e8d6458d8bbe.zip |
fix documentation for lock_dir
-rw-r--r-- | manual.html | 10 |
1 files 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: | |||
172 | Returns <code>true</code> in case of success or <code>nil</code> plus an | 172 | Returns <code>true</code> in case of success or <code>nil</code> plus an |
173 | error string.</dd> | 173 | error string.</dd> |
174 | 174 | ||
175 | <dt><a name="chdir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt> | 175 | <dt><a name="chdir"></a><strong><code>lfs.lock_dir(path)</code></strong></dt> |
176 | <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not | 176 | <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not |
177 | exist and returns the lock. If the lock already exists checks it | 177 | exist and returns the lock. |
178 | it's stale, using the second parameter (default for the second | 178 | To free the the lock call <code>lock:free()</code>. <br/> |
179 | parameter is <code>INT_MAX</code>, which in practice means the lock will never | ||
180 | be stale. To free the the lock call <code>lock:free()</code>. <br/> | ||
181 | In case of any errors it returns nil and the error message. In | 179 | In case of any errors it returns nil and the error message. In |
182 | particular, if the lock exists and is not stale it returns the | 180 | particular, if the lock exists it returns the |
183 | "File exists" message.</dd> | 181 | "File exists" message.</dd> |
184 | 182 | ||
185 | <dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt> | 183 | <dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt> |