From 4b5620058690614fa27ca38af2e3208ecc2ffe03 Mon Sep 17 00:00:00 2001
From: nvt-se <nvt-se>
Date: Thu, 29 Jan 2009 18:24:58 +0000
Subject: [PATCH] documented the new function that helps sensornet
 checkpointing to protect file descriptors while rolling back state.

---
 core/cfs/cfs-coffee.h | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/core/cfs/cfs-coffee.h b/core/cfs/cfs-coffee.h
index e959d3afe..2f86dd816 100644
--- a/core/cfs/cfs-coffee.h
+++ b/core/cfs/cfs-coffee.h
@@ -38,8 +38,6 @@
 #ifndef CFS_COFFEE_H
 #define CFS_COFFEE_H
 
-void *cfs_coffee_get_fd_set(unsigned *size);
-
 /**
  * \file
  *	Header for the Coffee file system.
@@ -87,6 +85,19 @@ int cfs_coffee_configure_log(const char *file, unsigned log_size,
  */
 int cfs_coffee_format(void);
 
+/**
+ * \brief Gives information about the file descriptor area in Coffee.
+ * \param size
+ * \return A pointer to the file descriptor set.
+ *
+ * This function returns the file descriptor set and sets the size
+ * argument to the number of bytes that the set uses. Mainly used for
+ * sensornet checkpointing to protect the file descriptor while rolling
+ * back the state from a file.
+ */
+void *cfs_coffee_get_fd_set(unsigned *size);
+
+
 /** @} */
 /** @} */