[PATCH] man: fix io_cancel() signature

Caleb Sander Mateos <[email protected]>
Newsgroups gmane.linux.kernel.aio.general
Message-ID <[email protected]>
Fix the man page signature of io_cancel() to match its actual signature
in libaio.h. Add the missing struct io_event * argument.

Italize "result" in the description to clarify it refers to the function
argument.

Signed-off-by: Caleb Sander Mateos <[email protected]>
---
 man/io_cancel.3 | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/man/io_cancel.3 b/man/io_cancel.3
index 8c6910e..2d08086 100644
--- a/man/io_cancel.3
+++ b/man/io_cancel.3
@@ -7,11 +7,11 @@ io_cancel \- Cancel io requests
 .sp
 .br
 .B #include <libaio.h>
 .sp
 .br
-.BI "int io_cancel(io_context_t " ctx ", struct iocb *" iocb ");"
+.BI "int io_cancel(io_context_t " ctx ", struct iocb *" iocb ", struct io_event *" result ");"
 .br
 .sp
 struct iocb {
 	void		*data; /* Return in the io completion event */
 	unsigned	key;	/* For use in identifying io requests */
@@ -24,12 +24,13 @@ struct iocb {
 Attempts to cancel an
 .I iocb
 previously passed to
 .BR io_submit (3).
 If the operation is successfully cancelled, the resulting event is
-copied into the memory pointed to by result without being placed
-into the completion queue.
+copied into the memory pointed to by
+.I result
+without being placed into the completion queue.
 .PP
 When one or more requests are asynchronously processed, it might be
 useful in some situations to cancel a selected operation, e.g., if it
 becomes obvious that the written data is no longer accurate and would
 have to be overwritten soon.  As an example, assume an application, which
-- 
2.45.2


--
To unsubscribe, send a message with 'unsubscribe linux-aio' in
the body to [email protected].  For more info on Linux AIO,
see: http://www.kvack.org/aio/
Don't email: <a href=mailto:"[email protected]">[email protected]</a>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.