lihao/luafilesystem
1
0
Fork 0
mirror of https://github.com/lunarmodules/luafilesystem.git synced 2026-07-24 12:23:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix documentation for lock_dir

Browse Source
This commit is contained in:
Fabio Mascarenhas
2011-06-09 18:11:38 -03:00
parent 4d8bc7eb62
commit fcdf88d43e
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
manual.html
View File

@@ -172,14 +172,12 @@ LuaFileSystem offers the following functions:
Returns <code>true</code> in case of success or <code>nil</code> plus an Returns <code>true</code> in case of success or <code>nil</code> plus an
error string.</dd> error string.</dd>
<dt><a name="chdir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt> <dt><a name="chdir"></a><strong><code>lfs.lock_dir(path)</code></strong></dt>
<dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not
exist and returns the lock. If the lock already exists checks it exist and returns the lock.
it's stale, using the second parameter (default for the second To free the the lock call <code>lock:free()</code>. <br/>
parameter is <code>INT_MAX</code>, which in practice means the lock will never
be stale. To free the the lock call <code>lock:free()</code>. <br/>
In case of any errors it returns nil and the error message. In 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.</dd> "File exists" message.</dd>
<dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt> <dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt>