about summary refs log tree commit diff
path: root/manual
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.de>2012-04-11 09:20:50 +0200
committerAndreas Jaeger <aj@suse.de>2012-04-11 09:20:50 +0200
commit4cfd80263af2a94c6a2046ef43d2dc511bc15188 (patch)
tree5da9ec16e78653077eac47858463e8096dc68f87 /manual
parentd7dd44133f53e8bcc81e18c11694bee985cd86d0 (diff)
downloadglibc-4cfd80263af2a94c6a2046ef43d2dc511bc15188.tar.gz
glibc-4cfd80263af2a94c6a2046ef43d2dc511bc15188.tar.xz
glibc-4cfd80263af2a94c6a2046ef43d2dc511bc15188.zip
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.
Diffstat (limited to 'manual')
-rw-r--r--manual/conf.texi4
-rw-r--r--manual/time.texi19
2 files changed, 12 insertions, 11 deletions
diff --git a/manual/conf.texi b/manual/conf.texi
index 2cd41f6c73..61dc260317 100644
--- a/manual/conf.texi
+++ b/manual/conf.texi
@@ -360,8 +360,8 @@ Inquire about the parameter corresponding to @code{_POSIX_VERSION}.
 @comment unistd.h
 @comment POSIX.1
 @item _SC_CLK_TCK
-Inquire about the parameter corresponding to @code{CLOCKS_PER_SEC};
-@pxref{CPU Time}.
+Inquire about the number of clock ticks per second; @pxref{CPU Time}.
+The corresponding parameter @code{CLK_TCK} is obsolete.
 
 @comment unistd.h
 @comment GNU
diff --git a/manual/time.texi b/manual/time.texi
index a410def3eb..7dff44f42c 100644
--- a/manual/time.texi
+++ b/manual/time.texi
@@ -237,12 +237,6 @@ 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
 This is the type of the value returned by the @code{clock} function.
@@ -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