summaryrefslogtreecommitdiff
path: root/manual/manual.of
diff options
context:
space:
mode:
authorRoberto Ierusalimschy <roberto@inf.puc-rio.br>2023-05-02 16:41:43 -0300
committerRoberto Ierusalimschy <roberto@inf.puc-rio.br>2023-05-02 16:41:43 -0300
commit6443185167c77adcc8552a3fee7edab7895db1a9 (patch)
tree20add1421687313b7dcb4b9481771ed60d21d3c5 /manual/manual.of
parente15f1f2bb7a38a3c94519294d031e48508d65006 (diff)
downloadlua-github-master.tar.gz
"Emergency" new version 5.4.6HEADv5.4.6master
'lua_resetthread' is back to its original signature, to avoid incompatibilities in the ABI between releases of the same version. New function 'lua_closethread' added with the "correct" signature.
Diffstat (limited to 'manual/manual.of')
-rw-r--r--manual/manual.of40
1 files changed, 25 insertions, 15 deletions
diff --git a/manual/manual.of b/manual/manual.of
index ac1d7e60..f8d8ddd4 100644
--- a/manual/manual.of
+++ b/manual/manual.of
@@ -3167,6 +3167,27 @@ when called through this function.
}
+@APIEntry{int lua_closethread (lua_State *L, lua_State *from);|
+@apii{0,?,-}
+
+Resets a thread, cleaning its call stack and closing all pending
+to-be-closed variables.
+Returns a status code:
+@Lid{LUA_OK} for no errors in the thread
+(either the original error that stopped the thread or
+errors in closing methods),
+or an error status otherwise.
+In case of error,
+leaves the error object on the top of the stack.
+
+The parameter @id{from} represents the coroutine that is resetting @id{L}.
+If there is no such coroutine,
+this parameter can be @id{NULL}.
+
+(This function was introduced in @N{release 5.4.6}.)
+
+}
+
@APIEntry{int lua_compare (lua_State *L, int index1, int index2, int op);|
@apii{0,0,e}
@@ -4160,23 +4181,12 @@ and then pops the top element.
}
-@APIEntry{int lua_resetthread (lua_State *L, lua_State *from);|
+@APIEntry{int lua_resetthread (lua_State *L);|
@apii{0,?,-}
-Resets a thread, cleaning its call stack and closing all pending
-to-be-closed variables.
-Returns a status code:
-@Lid{LUA_OK} for no errors in the thread
-(either the original error that stopped the thread or
-errors in closing methods),
-or an error status otherwise.
-In case of error,
-leaves the error object on the top of the stack.
-
-The parameter @id{from} represents the coroutine that is resetting @id{L}.
-If there is no such coroutine,
-this parameter can be @id{NULL}.
-(This parameter was introduced in @N{release 5.4.5}.)
+This function is deprecated;
+it is equivalent to @Lid{lua_closethread} with
+@id{from} being @id{NULL}.
}