Changeset f1ccfde in rtems

Timestamp:

09/29/98 21:51:08 (25 years ago)

Author:

Wade A Smith <warm38@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

80189ac2

Parents:

21bfd93

Message:

Made cosmetic changes to the file and documented the time, times, and
getimeofday routines.

File:

• doc/new_chapters/clock.t (modified) (5 diffs)

doc/new_chapters/clock.t

@@ -21 +21 @@
 @item @code{sleep} - Delay Process Execution
 @item @code{nanosleep} -
-@item @code{gettimeofday} -
-@item @code{time} -
+@item @code{gettimeofday} - Get the Time of Day
+@item @code{time} - Get time in seconds
+@item @code{times} - Get process times
 @end itemize
 
@@ -204 +205 @@
 
 @page
-@subsection gettimeofday -
+@subsection gettimeofday - Get the Time of Day
 
 @subheading CALLING SEQUENCE:
@@ -220 +221 @@
 @subheading STATUS CODES:
 
-On error, this routine returns -1 and sets errno as appropriate.
-
-@subheading DESCRIPTION:
-
-@subheading NOTES:
-
-Currently, the timezone information is not supported.
-
-@page
-@subsection time -
+On error, this routine returns -1 and sets @code{errno} as appropriate.
+
+@table @b
+@item EPERM
+@code{settimeofdat} is called by someone other than the superuser.
+
+@item EINVAL
+Timezone (or something else) is invalid.
+
+@item EFAULT
+One of @code{tv} or @code{tz} pointed outside your accessible address 
+space
+
+@end table
+
+@subheading DESCRIPTION:
+
+This routine returns the current time of day in the @code{tp} structure.
+
+@subheading NOTES:
+
+Currently, the timezone information is not supported.  The @code{tzp}
+argument is ignored.
+
+@page
+@subsection time - Get time in seconds
  
 @subheading CALLING SEQUENCE:
@@ -246 +263 @@
 
 @subheading DESCRIPTION:
+
+@code{time} returns the time since 00:00:00 GMT, January 1, 1970, 
+measured in seconds
+
+If @code{tloc} in non null, the return value is also stored in the 
+memory pointed to by @code{t}.
  
 @subheading NOTES:
@@ -251 +274 @@
 NONE
  
+@page
+@subsection times - Get process times
+ 
+@subheading CALLING SEQUENCE:
+ 
+@example
+#include <sys/time.h>
+ 
+int time(
+  clock_t times(struct tms *buf
+);
+@end example
+ 
+@subheading STATUS CODES:
+
+This routine returns the process times
+
+@subheading DESCRIPTION:
+
+@code{times} stores the current process times in @code{buf}.
+
+@code{struct tms} is as defined in @code{/usr/include/sys/times.h}:
+
+struct  tms  {
+             clock_t tms_utime;  /* user time */
+             clock_t tms_stime;  /* system time */
+             clock_t tms_cutime; /* user time of children */
+             clock_t tms_cstime; /* system time of children */
+             };
+
+@code{times} returns the number of clock ticks that have elapsed
+since the systm has been up.
+ 
+@subheading NOTES:
+
+NONE
+