From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp32.i.mail.ru (smtp32.i.mail.ru [94.100.177.92]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dev.tarantool.org (Postfix) with ESMTPS id 387C646971A for ; Wed, 4 Dec 2019 00:59:19 +0300 (MSK) From: Olga Arkhangelskaia Date: Wed, 4 Dec 2019 00:59:11 +0300 Message-Id: <20191203215911.77284-1-arkholga@tarantool.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [Tarantool-patches] [PATCH] lib: fix comment in coio_task.h List-Id: Tarantool development patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: tarantool-patches@dev.tarantool.org According to code coio_call does not take a timeout as an argument, however it was mentioned in the comment and usage example. This lead to error in documentation. The patch fixes it. Closes #4663 --- src/lib/core/coio_task.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/lib/core/coio_task.h b/src/lib/core/coio_task.h index e81e10cca..29b144dea 100644 --- a/src/lib/core/coio_task.h +++ b/src/lib/core/coio_task.h @@ -131,8 +131,7 @@ coio_task_post(struct coio_task *task); /** * Create new eio task with specified function and - * arguments. Yield and wait until the task is complete - * or a timeout occurs. + * arguments. Yield and wait until the task is complete. * * This function doesn't throw exceptions to avoid double error * checking: in most cases it's also necessary to check the return @@ -150,7 +149,7 @@ coio_task_post(struct coio_task *task); * return open(filename, flags); * } * - * if (coio_call(openfile_cb, 0.10, "/tmp/file", 0) == -1) + * if (coio_call(openfile_cb, "/tmp/file", 0) == -1) * // handle errors. * ... * @endcode -- 2.20.1 (Apple Git-117)