From: Martin Mares <mj@ucw.cz>
Date: Tue, 29 May 2007 20:16:59 +0000 (+0200)
Subject: Added a couple of comments.
X-Git-Tag: holmes-import~506^2~13^2~116
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=bb483446d9c8a0227887aa2b3e7494a973d06593;p=libucw.git

Added a couple of comments.
---

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index e5bba535..475f8335 100644
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -75,16 +75,16 @@ struct fastbuf {
 
 /* FastIO on files with run-time parametrization */
 
-enum fb_type {
-  FB_STD,
-  FB_DIRECT,
-  FB_MMAP
+enum fb_type {				/* Which back-end you want to use */
+  FB_STD,				/* Standard buffered I/O */
+  FB_DIRECT,				/* Direct I/O bypassing system caches */
+  FB_MMAP				/* Memory mapped files */
 };
 
 struct fb_params {
   enum fb_type type;
   uns buffer_size;
-  uns read_ahead;
+  uns read_ahead;			/* The next three fields are used for FB_DIRECT files */
   uns write_back;
   struct asio_queue *asio;
 };
@@ -93,7 +93,7 @@ struct cf_section;
 extern struct cf_section fbpar_cf;
 extern struct fb_params fbpar_def;
 
-struct fastbuf *bopen_file(byte *name, int mode, struct fb_params *params);
+struct fastbuf *bopen_file(byte *name, int mode, struct fb_params *params);		/* Use params==NULL for defaults */
 struct fastbuf *bopen_file_try(byte *name, int mode, struct fb_params *params);
 struct fastbuf *bopen_tmp_file(struct fb_params *params);
 struct fastbuf *bopen_fd(int fd, struct fb_params *params);