Add caveat on the clock_getres() resolution
authorJarkko Hietaniemi <jhi@iki.fi>
Thu, 14 Jan 2016 15:31:01 +0000 (10:31 -0500)
committerJarkko Hietaniemi <jhi@iki.fi>
Sat, 13 Feb 2016 16:39:11 +0000 (11:39 -0500)
dist/Time-HiRes/HiRes.pm

index 1f307fb..aa5349d 100644 (file)
@@ -361,6 +361,13 @@ specified by C<$which>.  All implementations that support POSIX high
 resolution timers are supposed to support at least the C<$which> value
 of C<CLOCK_REALTIME>, see L</clock_gettime>.
 
+B<NOTE>: the resolution returned may be highly optimistic.  Even if
+the resolution is high (a small number), all it means is that you'll
+be able to specify the arguments to clock_gettime() and clock_nanosleep()
+with that resolution.  The system might not actually be able to measure
+events at that resolution, and the various overheads and the overall system
+load are certain to affect any timings.
+
 =item clock_nanosleep ( $which, $nanoseconds, $flags = 0)
 
 Sleeps for the number of nanoseconds (1e9ths of a second) specified.