Browse Source

Mention mount/unmount aren't threadsafe;

bjorn 4 years ago
parent
commit
1a509b0f90
2 changed files with 7 additions and 0 deletions
  1. 3 0
      api/lovr/filesystem/mount.lua
  2. 4 0
      api/lovr/filesystem/unmount.lua

+ 3 - 0
api/lovr/filesystem/mount.lua

@@ -44,6 +44,9 @@ return {
   notes = [[
     The `append` option lets you control the priority of the archive's files in the event of naming
     collisions.
+
+    This function is not thread safe.  Mounting or unmounting an archive while other threads call
+    lovr.filesystem functions is not supported.
   ]],
   example = {
     description = 'Mount `data.zip` with a file `images/background.png`:',

+ 4 - 0
api/lovr/filesystem/unmount.lua

@@ -15,6 +15,10 @@ return {
       description = 'Whether the archive was unmounted.'
     }
   },
+  notes = [[
+    This function is not thread safe.  Mounting or unmounting an archive while other threads call
+    lovr.filesystem functions is not supported.
+  ]],
   related = {
     'lovr.filesystem.mount'
   }