Lua: update l_register_handler() function documentation

Message ID 20171012150408.23257-1-christian.storm@siemens.com
State Accepted
Headers show
Series
  • Lua: update l_register_handler() function documentation
Related show

Commit Message

Christian Storm Oct. 12, 2017, 3:04 p.m.
Commit cc0101e "Lua: Lua'ify l_register_handler() error path"
changed the return values of l_register_handler().
Adapt the function documentation accordingly.

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

Comments

Stefano Babic Oct. 17, 2017, 7:19 a.m. | #1
On 12/10/2017 17:04, Christian Storm wrote:
> Commit cc0101e "Lua: Lua'ify l_register_handler() error path"
> changed the return values of l_register_handler().
> Adapt the function documentation accordingly.
> 
> Signed-off-by: Christian Storm <christian.storm@siemens.com>
> ---
>  corelib/lua_interface.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/corelib/lua_interface.c b/corelib/lua_interface.c
> index 8698a1d..df9efaa 100644
> --- a/corelib/lua_interface.c
> +++ b/corelib/lua_interface.c
> @@ -474,7 +474,7 @@ static int l_handler_wrapper(struct img_type *img, void *data) {
>   * from any lua script in the same context (Stack)
>   *
>   * @param [in] the lua Stack
> - * @return This function returns 0 if successfull and -1 if unsuccessfull.
> + * @return This function returns 0 values back to Lua.
>   */
>  static int l_register_handler( lua_State *L ) {
>  	int *l_func_ref = malloc(sizeof(int));
> 

Acked-by: Stefano Babic <sbabic@denx.de>

Best regards,
Stefano Babic

Patch

diff --git a/corelib/lua_interface.c b/corelib/lua_interface.c
index 8698a1d..df9efaa 100644
--- a/corelib/lua_interface.c
+++ b/corelib/lua_interface.c
@@ -474,7 +474,7 @@  static int l_handler_wrapper(struct img_type *img, void *data) {
  * from any lua script in the same context (Stack)
  *
  * @param [in] the lua Stack
- * @return This function returns 0 if successfull and -1 if unsuccessfull.
+ * @return This function returns 0 values back to Lua.
  */
 static int l_register_handler( lua_State *L ) {
 	int *l_func_ref = malloc(sizeof(int));