Re: documenting io_pgetevents

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

 



Hello Christoph,

Sorry for the very late response...

On 8/28/18 9:08 AM, Christoph Hellwig wrote:
> Hi Michael,
> 
> I'd like to document io_pgetevents in man-pages in the man-pages
> project in addition to the libaio man page here:
> 
>   http://git.infradead.org/users/hch/libaio.git/commitdiff/49f77d595210393ce7b125cb00233cf737402f56
> 
> But given that io_pgetevent has the same weird sigsetsize + sigset
> indirection as pselect, but does not have a glibc wrapper I wonder
> how to document it, given that we already have a proper .3 man page
> in libaio for the user API.  The current io_getevents man pages
> already shows a C prototype for something that can only
> used through syscall() - should I use the actual prototype of the
> syscall, or the fake prototype unfolding the argument indirection?

I think: use the actual prototype of the system call. (There's
precedent for this sort of thing in, for example, the NOTES secstions
on the select(2), poll(2), and epoll_wait(2) manual pages.

Could you send a patch onto the mailing list?

Thanks,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/



[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