changeset 60:c2a1db5e3fe1

Two additional warnings for Level.Invocation.
author shade
date Fri, 31 May 2013 15:57:23 +0400
parents 813ec6837fa3
children f9f1eed3e7a5
files jmh-core/src/main/java/org/openjdk/jmh/annotations/Level.java
diffstat 1 files changed, 11 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-core/src/main/java/org/openjdk/jmh/annotations/Level.java	Fri May 31 15:45:14 2013 +0400
+++ b/jmh-core/src/main/java/org/openjdk/jmh/annotations/Level.java	Fri May 31 15:57:23 2013 +0400
@@ -44,9 +44,17 @@
     /**
      * Invocation level.
      *
-     * To be executed for each benchmark method execution. Note this might
-     * bring in the unwanted performance effects for the benchmark runs.
-     * Use with the extreme care!
+     * To be executed for each benchmark method execution.
+     *
+     * <p>WARNING #1: This level will bring the unwanted performance
+     * effects for the benchmark runs. The use is mostly warranted
+     * with the large benchmarks, when the overhead of making the
+     * timestamps for each invocation is negligible. It is almost
+     * never a good idea to use this otherwise.
+     *
+     * <p>WARNING #2: Because JMH can not afford synchronizing the
+     * state on which the Level.Invocation helper is being called,
+     * the helper method execution may overlap with the work itself.
      */
     Invocation,
 }