From: Pavel Charvat <pavel.charvat@netcentrum.cz>
Date: Wed, 6 Jun 2007 08:24:23 +0000 (+0200)
Subject: documented fbpool briefly
X-Git-Tag: holmes-import~506^2~13^2~102
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=d5e8872563f6fde8299db971ffb6494c2438c590;p=libucw.git

documented fbpool briefly
---

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index 1020427b..09114f4c 100644
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -152,9 +152,11 @@ struct fbpool {
   struct mempool *mp;
 };
 
-void fbpool_init(struct fbpool *fb);
+void fbpool_init(struct fbpool *fb);	/* Initialize a new fastbuf */
 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
-void *fbpool_end(struct fbpool *fb);
+					/* Start a new continuous block and prepare for writing (see mp_start()) */
+void *fbpool_end(struct fbpool *fb);	/* Close the block and return its address (see mp_end()).
+					   The length can be determined with mp_size(mp, ptr). */
 
 /* FastO with atomic writes for multi-threaded programs */