diff mbox series

[1/3] Lua: Fix l_handler_wrapper() comment

Message ID 20220629183547.95496-1-christian.storm@siemens.com
State Accepted
Headers show
Series [1/3] Lua: Fix l_handler_wrapper() comment | expand

Commit Message

Storm, Christian June 29, 2022, 6:35 p.m. UTC
l_handler_wrapper() returns -1 for C realm errors.
Lua Handlers return 1 as error code as per the
documentation examples in doc/source/handlers.rst.
Fix the @return code comment.

Signed-off-by: Christian Storm <christian.storm@siemens.com>
---
 corelib/lua_interface.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/corelib/lua_interface.c b/corelib/lua_interface.c
index dd1be9e..22b373b 100644
--- a/corelib/lua_interface.c
+++ b/corelib/lua_interface.c
@@ -1105,7 +1105,7 @@  static lua_State *gL = NULL;
  * @param unused [in] unused in this context
  * @param data [in] pointer to the index in the Lua registry for the function
  * @param scriptfn [in] installation phase for script handlers, or NONE
- * @return This function returns 0 if successful and -1 if unsuccessful.
+ * @return This function returns 0 if successful and != 0 otherwise.
  */
 static int l_handler_wrapper(struct img_type *img, void *data,
 			     script_fn scriptfn) {