From 8e52b1bcfd90344a7b9ae52a5d5b860d93418c15 Mon Sep 17 00:00:00 2001
From: nvt-se <nvt-se>
Date: Mon, 4 May 2009 22:29:48 +0000
Subject: [PATCH] made the documentation more clear.

---
 core/cfs/cfs-coffee.h | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/core/cfs/cfs-coffee.h b/core/cfs/cfs-coffee.h
index d511441bf..de9d17e4a 100644
--- a/core/cfs/cfs-coffee.h
+++ b/core/cfs/cfs-coffee.h
@@ -57,9 +57,9 @@
  * \return 0 on success, -1 on failure.
  *
  * Coffee uses sequential page structures for files. The sequential 
- * structure can be reserved with a certain size. If no reservation
- * has been done, files will be set to a default size once opened for
- * the first time.
+ * structure can be reserved with a certain size. If a file has not 
+ * been reserved when it is opened for the first time, it will be 
+ * allocated with a default size.
  */
 int cfs_coffee_reserve(const char *name, cfs_offset_t size);
 
@@ -71,8 +71,9 @@ int cfs_coffee_reserve(const char *name, cfs_offset_t size);
  * \return 0 on success, -1 on failure.
  *
  * When file data is first modified, Coffee creates a micro log for the
- * file. The micro log stores a table of modifications where each record
- * is of log_entry_size.
+ * file. The micro log stores a table of modifications whose 
+ * parameters--the log size and the log entry size--can be modified 
+ * through the cfs_coffee_configure_log function.
  */
 int cfs_coffee_configure_log(const char *file, unsigned log_size,
                              unsigned log_entry_size);
@@ -82,14 +83,14 @@ int cfs_coffee_configure_log(const char *file, unsigned log_size,
  * \return 0 on success, -1 on failure.
  *
  * Coffee formats the underlying storage by setting all bits to zero.
- * This operation is required prior to using Coffee for the first time
- * in a system.
+ * Formatting must be done before using Coffee for the first time in
+ * a mote.
  */
 int cfs_coffee_format(void);
 
 /**
- * \brief Gives information about memory that must not be altered during
- * CFS-based checkpointing operations.
+ * \brief Points out a memory region that may not be altered during
+ * checkpointing operations that use the file system.
  * \param size
  * \return A pointer to the protected memory.
  *
@@ -99,7 +100,6 @@ int cfs_coffee_format(void);
  */
 void *cfs_coffee_get_protected_mem(unsigned *size);
 
-
 /** @} */
 /** @} */