Re: [PATCH 1/4] io_cancel.2: fix up the description

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi!
> > The description for this sytem call was a bit inaccurate.  Cyril
> > still takes issue with my wording, so this is up for further
> > word-smithing, I think.  I'm open to suggestions.
> 
> Cyril, do you have any comment?

It is no big deal but I think that the sentence could be a little clearer
with explicitly stating that the ctx_id is aio context and the iocb
describes the operation to be canceled. Something like:

The
.I iocb
describes the operation to be canceled and the
.I ctx_id
is aio context the operation was submitted to.

> > Signed-off-by: Jeff Moyer <jmoyer@xxxxxxxxxx>
> > ---
> >  man2/io_cancel.2 |    8 ++++----
> >  1 files changed, 4 insertions(+), 4 deletions(-)
> >
> > diff --git a/man2/io_cancel.2 b/man2/io_cancel.2
> > index 0f974ed..6adddf3 100644
> > --- a/man2/io_cancel.2
> > +++ b/man2/io_cancel.2
> > @@ -26,10 +26,10 @@ attempts to cancel an asynchronous I/O operation previously submitted with
> >  .BR io_submit (2).
> >  The
> >  .I ctx_id
> > -argument is the AIO context ID of the operation to be canceled.
> > -If the AIO context is found, the event will be canceled and then copied
> > -into the memory pointed to by \fIresult\fP without being placed
> > -into the completion queue.
> > +argument is the AIO context ID into which the operation was submitted.
> > +If the operation is successfully canceled, the event will be copied into
> > +the memory pointed to by \fIresult\fP without being placed into the
> > +completion queue.
> >  .SH RETURN VALUE
> >  On success,
> >  .BR io_cancel ()
> > --
> > 1.7.1
> >
> 
> 
> 
> --
> Michael Kerrisk
> Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
> Author of "The Linux Programming Interface"; http://man7.org/tlpi/

-- 
Cyril Hrubis
chrubis@xxxxxxx
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux