deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

made the documentation more clear.

Browse source
This commit is contained in:
nvt-se 2009-05-04 22:29:48 +00:00
parent 3eac697f85
commit 8e52b1bcfd
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
core/cfs/cfs-coffee.h
View file

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