From 4cfd80263af2a94c6a2046ef43d2dc511bc15188 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 11 Apr 2012 09:20:50 +0200 Subject: Fix times return value, CLK_TCK description [BZ #2636] * manual/time.texi (Processor Time): Return type of times is elapsed real time since an arbitrary point in the past. (CPU Time): Move CLK_TCK from here... (Processor Time): ...to here. Correct description. * manual/conf.texi (Constants for Sysconf): Correct description of _SC_CLK_TCK. --- manual/time.texi | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'manual/time.texi') diff --git a/manual/time.texi b/manual/time.texi index a410def3eb..7dff44f42c 100644 --- a/manual/time.texi +++ b/manual/time.texi @@ -236,12 +236,6 @@ by the @code{clock} function. POSIX requires that this value be one million independent of the actual resolution. @end deftypevr -@comment time.h -@comment POSIX.1 -@deftypevr Macro int CLK_TCK -This is an obsolete name for @code{CLOCKS_PER_SEC}. -@end deftypevr - @comment time.h @comment ISO @deftp {Data Type} clock_t @@ -306,15 +300,22 @@ these are the actual amounts of time; not relative to any event. @xref{Creating a Process}. @end deftp +@comment time.h +@comment POSIX.1 +@deftypevr Macro int CLK_TCK +This is an obsolete name for the number of clock ticks per second. Use +@code{sysconf (_SC_CLK_TCK)} instead. +@end deftypevr + @comment sys/times.h @comment POSIX.1 @deftypefun clock_t times (struct tms *@var{buffer}) The @code{times} function stores the processor time information for the calling process in @var{buffer}. -The return value is the calling process' CPU time (the same value you -get from @code{clock()}. @code{times} returns @code{(clock_t)(-1)} to -indicate failure. +The return value is the number of clock ticks since an arbitrary point +in the past, e.g. since system start-up. @code{times} returns +@code{(clock_t)(-1)} to indicate failure. @end deftypefun @strong{Portability Note:} The @code{clock} function described in -- cgit v1.2.3