r4066 - trunk/birnet

[timj svn gnome org]

Author: timj
Date: 2006-11-04 16:18:41 -0500 (Sat, 04 Nov 2006)
New Revision: 4066

Modified:
   trunk/birnet/birnettests.h
Log:
updated comments


Modified: trunk/birnet/birnettests.h
===================================================================
--- trunk/birnet/birnettests.h	2006-11-04 19:14:35 UTC (rev 4065)
+++ trunk/birnet/birnettests.h	2006-11-04 21:18:41 UTC (rev 4066)
@@ -260,10 +260,18 @@
   TABORT_call();                                        \
 } while (0)
 
-/* Given an upper test duration bound, this macro will return the number
+/* TEST_CALIBRATION() - This macro is used to calculate the number of
+ * repetitions needed for execution of a test routine, so that the total
+ * duration is long enough to be measured by a timer with millisecond
+ * resolution like gettimeofday().
+ * Given an upper test duration bound, this macro will return the number
  * of inner loop repetitions needed for benchmarking a piece of code.
  * Estimated run time: the calibration process should take somewhat
  * less than MIN (max_calibration_time, (target_ms * 2 * 7)) milliseconds.
+ * @arg target_ms       expected total test runtime for RUNS * dups * testfunc_time
+ * @var max_calibration_time expected upper bound for test calibration runtime
+ * In this macro, "dups" is calculated appropriately for max_calibration_time,
+ * and scaled upon return to match target_ms accordingly.
  */
 #define TEST_CALIBRATION(target_ms, CODE)		({			 	\
   const guint   runs = 7;                                                               \