summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2009-12-17 20:34:58 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2009-12-17 20:34:58 +0000
commit3372dc824240aa12010c2de6389bc6b061c1f3db (patch)
tree462242e15ad155f2cc9043e40fb7da1cf2163b61 /doc
parent2009-12-17 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-3372dc824240aa12010c2de6389bc6b061c1f3db.tar.bz2
2009-12-17 Joel Sherrill <joel.sherrill@oarcorp.com>
* user/clock.t: Eliminate unused type rtems_clock_time_value.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog4
-rw-r--r--doc/user/clock.t32
2 files changed, 11 insertions, 25 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 57ded9516f..aeb07831c0 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2009-12-17 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ * user/clock.t: Eliminate unused type rtems_clock_time_value.
+
2009-12-16 Thomas Doerfler <Thomas.Doerfler@embedded-brains.de>
* bsp_howto/console.t: adaption to ssize_t return value for
diff --git a/doc/user/clock.t b/doc/user/clock.t
index 0ba51130d4..784992c7f1 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -85,34 +85,16 @@ type Time_Of_Day is
The native date and time format is the only format
supported when setting the system date and time using the
-@code{@value{DIRPREFIX}clock_get} directive. Some applications
+@code{@value{DIRPREFIX}clock_set} directive. Some applications
expect to operate on a "UNIX-style" date and time data structure. The
+@code{@value{DIRPREFIX}clock_get_tod_timeval} always returns
+the date and time in @code{struct timeval} format. The
@code{@value{DIRPREFIX}clock_get} directive can optionally return
-the current date and time in the
-following @value{STRUCTURE}:
+the current date and time in this format.
-@ifset is-C
-@example
-@group
-typedef struct @{
- uint32_t seconds; /* seconds since RTEMS epoch*/
- uint32_t microseconds; /* since last second */
-@} rtems_clock_time_value;
-@end group
-@end example
-@end ifset
-
-@ifset is-Ada
-@example
-type Clock_Time_Value is
- record
- Seconds : Unsigned32;
- Microseconds : Unsigned32;
- end record;
-@end example
-@end ifset
-
-The seconds field in this @value{STRUCTURE} is the number of seconds
+The @code{struct timeval} data structure has two fields: @code{tv_sec}
+and @code{tv_usec} which are seconds and microseconds, respectively.
+The @code{tv_sec} field in this data structure is the number of seconds
since the POSIX epoch of January 1, 1970 but will never be prior to
the RTEMS epoch of January 1, 1988.