From b2165944970b74dee215d3451f5f94fe4579d49d Mon Sep 17 00:00:00 2001 From: George Kiagiadakis Date: Wed, 6 Apr 2022 20:23:23 +0300 Subject: [PATCH] docs: fix sandbox documentation to reflect changes --- docs/rst/lua_api/lua_introduction.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rst/lua_api/lua_introduction.rst b/docs/rst/lua_api/lua_introduction.rst index 59d4dc1f..ead49893 100644 --- a/docs/rst/lua_api/lua_introduction.rst +++ b/docs/rst/lua_api/lua_introduction.rst @@ -37,15 +37,15 @@ In this environment, the following rules apply: ``string.format = rogue_format`` is valid outside the sandbox. WirePlumber does not allow that. - - The standard Lua API is limited only to safe functions. Functions that - interact with the file system, the lua modules system, the lua state, - the process's state, etc are **not** allowed. + - The standard Lua API is limited to a subset of safe functions. For instance, + functions that interact with the file system (io.*) and the process's state + (ex.: os.exit) are **not** allowed. Here is a full list of Lua functions (and API tables) that are exposed: .. literalinclude:: ../../../modules/module-lua-scripting/wplua/sandbox.lua :language: lua - :lines: 40-55 + :lines: 27-30 - Object methods are not exposed in public tables. To call an object method you must use the method call syntax of Lua, i.e. ``object:method(params)``