]> Savannah Git Hosting - gnulib.git/commitdiff
clock_getres: document portability issues better
authorPaul Eggert <eggert@cs.ucla.edu>
Tue, 28 Dec 2021 20:03:37 +0000 (12:03 -0800)
committerPaul Eggert <eggert@cs.ucla.edu>
Tue, 28 Dec 2021 20:04:49 +0000 (12:04 -0800)
* doc/posix-functions/clock_getres.texi:
* doc/posix-functions/timespec_getres.texi:
Document problems with timestamp resolution.

ChangeLog
doc/posix-functions/clock_getres.texi
doc/posix-functions/timespec_getres.texi

index 79739541e4e4c796d701a09b052fe00b86631aa0..ac8d1baeae3ef59b7c4c6b40c8dc72ba54fb092f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2021-12-28  Paul Eggert  <eggert@cs.ucla.edu>
 
+       clock_getres: document portability issues better
+       * doc/posix-functions/clock_getres.texi:
+       * doc/posix-functions/timespec_getres.texi:
+       Document problems with timestamp resolution.
+
        timespec_getres: new module
        * lib/time.in.h (timespec_getres): New decl.
        * lib/timespec_getres.c, m4/timespec_getres.m4:
index 1381c4649c66c06171b035ff60ee352ed8114d1b..e93e8b30f5ce9763248b6b4e61df23049cfe00be 100644 (file)
@@ -15,7 +15,16 @@ Portability problems not fixed by Gnulib:
 @item
 This function is missing on some platforms:
 Mac OS X 10.11, Minix 3.1.8, mingw, MSVC 14.
+
+@item
+On many platforms, this function returns a value other than the clock
+resolution of @code{clock_gettime}, i.e., the minimum distance between
+differing timestamps.  For example, on AIX 7.2 it returns 10
+milliseconds even though the clock resolution is 1 microsecond.
+Conversely, on GNU/Linux it typically returns 1 nanosecond even
+though the clock resolution may be greater.
 @end itemize
 
 The Gnulib module @code{gettime-res} is a partial substitute; it implements
-the @code{CLOCK_REALTIME} functionality of @code{clock_getres}.
+the @code{CLOCK_REALTIME} functionality of @code{clock_getres},
+and fixes the too-high resolution bug of platforms like AIX 7.2.
index 89d3e6f16fa50587cf7f41b4e79134edb0b0f7d3..c18a3635fff2d21afa3c000b188b2889884b57af 100644 (file)
@@ -15,4 +15,12 @@ glibc 2.33, macOS 12, FreeBSD 13.0, NetBSD 9.2, OpenBSD 7.0, Minix 3.3.0, AIX 7.
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+On some platforms, this function returns a value other than the clock
+resolution of @code{timespec_get}, i.e., the minimum distance between
+differing timestamps.  For example, on GNU/Linux it typically returns
+1 nanosecond regardless of the actual clock resolution.
 @end itemize
+
+The Gnulib module @code{gettime-res} is a partial substitute; it implements
+the @code{TIME_UTC} functionality of @code{timespec_getres}.