From: Martin Mares <mj@ucw.cz>
Date: Thu, 16 Feb 2012 19:19:51 +0000 (+0100)
Subject: Time: Documented the header splitoff
X-Git-Tag: v5.0~35
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=209b1b9a98f8d090ac69802f5147ebe3e1c84624;p=libucw.git

Time: Documented the header splitoff
---

diff --git a/ucw/doc/index.txt b/ucw/doc/index.txt
index aaaadc6e..e96443af 100644
--- a/ucw/doc/index.txt
+++ b/ucw/doc/index.txt
@@ -12,6 +12,8 @@ not described, so you might need to look into the source code.
 
 You can see the index of <<def_index:,documented definitions>>.
 
+For news and incompatible changes in this version, see the <<relnotes:,Release notes>>.
+
 Modules
 -------
 - <<basics:,Basics>>
@@ -45,7 +47,6 @@ Other features
 - <<config:,Configuration file syntax>>
 - <<docsys:,Documentation system>>
 - <<generic:,Macro-generated generics>>
-- <<relnotes:,Release notes>>
 
 Yet undocumented modules
 ------------------------
diff --git a/ucw/doc/relnotes.txt b/ucw/doc/relnotes.txt
index 7dfc41a3..8f46e1da 100644
--- a/ucw/doc/relnotes.txt
+++ b/ucw/doc/relnotes.txt
@@ -61,6 +61,7 @@ Release notes
 * *Incompatible:* Several modules now have their own header files:
 ** `process.h` -- all functions related to processes, previously declared in `lib.h`
 ** `io.h` -- functions related to files from `lib.h` and `lfs.h`
+** `time.h` -- timestamps and interval timers, previously in `lib.h`
 
 * *Incompatible:* Several configuration options were renamed or removed:
 ** `CONFIG_FAKE_ELTPOOL` &rarr; `CONFIG_UCW_FAKE_ELTPOOL`
diff --git a/ucw/time.h b/ucw/time.h
index 6d07cdc7..0684bec1 100644
--- a/ucw/time.h
+++ b/ucw/time.h
@@ -20,6 +20,8 @@
  * system boot if POSIX monotonic clock is used.
  ***/
 
+/* time-stamp.c */
+
 timestamp_t get_timestamp(void);		/** Get current time as a millisecond timestamp. **/
 
 /***
@@ -30,6 +32,8 @@ timestamp_t get_timestamp(void);		/** Get current time as a millisecond timestam
  * the number of milliseconds elapsed since the previous read or initialization.
  ***/
 
+/* time-timer.c */
+
 void init_timer(timestamp_t *timer);		/** Initialize a timer. **/
 uns get_timer(timestamp_t *timer);		/** Get the number of milliseconds since last init/get of a timer. **/
 uns switch_timer(timestamp_t *oldt, timestamp_t *newt);	/** Stop ticking of one timer and resume another. **/