bcache: add a comment

diff --git a/lib/device/bcache.h b/lib/device/bcache.h
index 2b0d9659f36ecb002e2913d31993e89e2c6c4836..6a18d33aba613204023271eb0bed2209cb3c7ebc 100644 (file)
--- a/lib/device/bcache.h
+++ b/lib/device/bcache.h
@@ -150,18 +150,18 @@ bool bcache_invalidate(struct bcache *cache, int fd, block_address index);
  */
 bool bcache_invalidate_fd(struct bcache *cache, int fd);
 
-/*
- * Prefetches the blocks neccessary to satisfy a byte range.
- */
+
+//----------------------------------------------------------------
+// The next four functions are utilities written in terms of the above api.
+ 
+// Prefetches the blocks neccessary to satisfy a byte range.
 void bcache_prefetch_bytes(struct bcache *cache, int fd, off_t start, size_t len);
 
-/*
- * Reads and writes the bytes.  Returns false if errors occur.
- */
+// Reads, writes and zeroes bytes.  Returns false if errors occur.
 bool bcache_read_bytes(struct bcache *cache, int fd, off_t start, size_t len, void *data);
 bool bcache_write_bytes(struct bcache *cache, int fd, off_t start, size_t len, void *data);
 bool bcache_write_zeros(struct bcache *cache, int fd, off_t start, size_t len);
 
-/*----------------------------------------------------------------*/
+//----------------------------------------------------------------
 
 #endif