From mboxrd@z Thu Jan 1 00:00:00 1970 From: Christoph Hellwig Date: Wed, 21 Nov 2018 15:34:44 +0100 Subject: [Cluster-devel] [PATCH V11 17/19] block: document usage of bio iterator helpers In-Reply-To: <1f93e845-09e8-2c6c-3643-654b8c490597@suse.com> References: <20181121032327.8434-1-ming.lei@redhat.com> <20181121032327.8434-18-ming.lei@redhat.com> <1f93e845-09e8-2c6c-3643-654b8c490597@suse.com> Message-ID: <20181121143443.GC2594@lst.de> List-Id: To: cluster-devel.redhat.com MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit On Wed, Nov 21, 2018 at 09:45:25AM +0200, Nikolay Borisov wrote: > > + bio_for_each_segment_all() > > + bio_first_bvec_all() > > + bio_first_page_all() > > + bio_last_bvec_all() > > + > > +* The following helpers iterate over single-page bvecs. The passed 'struct > > +bio_vec' will contain a single-page IO vector during the iteration > > + > > + bio_for_each_segment() > > + bio_for_each_segment_all() > > + > > +* The following helpers iterate over single-page bvecs. The passed 'struct > > +bio_vec' will contain a single-page IO vector during the iteration > > + > > + bio_for_each_bvec() > > Just put this helper right below the above 2, no need to repeat the > explanation. Also I'd suggest introducing another catch-all sentence > "All other helpers are assumed to iterate multipage bio vecs" and > perhaps give an example with 1-2 helpers. Well, I think the second explanation is wrong - bio_for_each_bvec iterates over the whole bvecs, not just single page.