From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Date: Wed, 31 May 2017 10:51:37 +0200 From: Jan Kara To: Goldwyn Rodrigues Cc: Christoph Hellwig , linux-fsdevel@vger.kernel.org, jack@suse.com, linux-block@vger.kernel.org, linux-btrfs@vger.kernel.org, linux-ext4@vger.kernel.org, linux-xfs@vger.kernel.org, axboe@kernel.dk, linux-api@vger.kernel.org, adam.manzanares@wdc.com, viro@zeniv.linux.org.uk, Goldwyn Rodrigues Subject: Re: [PATCH 09/10] xfs: nowait aio support Message-ID: <20170531085137.GB14011@quack2.suse.cz> References: <20170524164150.9492-1-rgoldwyn@suse.de> <20170524164150.9492-10-rgoldwyn@suse.de> <20170528093113.GB14519@infradead.org> <20170529083338.GC1899@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 In-Reply-To: List-ID: On Tue 30-05-17 11:13:29, Goldwyn Rodrigues wrote: > > Btw, can you write a small blurb up for the man page to document these > > Ñ•emantics in man-page like language? > > > > Yes, but which man page would it belong to? > Should it be a subsection of errors in io_getevents/io_submit. We don't > want to add ERRORS to io_getevents() because it would be the return > value of the io_getevents call, and not the ones in the iocb structure. > Should it be a new man page, say for iocb(7/8)? I think you should extend the manpage for io_submit(8). There you can add definition of struct iocb in 'DESCRIPTION' section explaining at least the most common fields. You can also explain there which flags can be passed and what are they intended to do. You can also expand EAGAIN error description to specifically mention that in case of NOWAIT aio EAGAIN can be returned if io submission would block. Honza -- Jan Kara SUSE Labs, CR