changeset 303:501b2f7a4ca2

@AuxCounters: mention global namespace for counter names.
author shade
date Thu, 05 Dec 2013 00:50:26 +0400
parents 9fcdbe9fd36c
children 6fcaa4228b4f
files jmh-core/src/main/java/org/openjdk/jmh/annotations/AuxCounters.java
diffstat 1 files changed, 6 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-core/src/main/java/org/openjdk/jmh/annotations/AuxCounters.java	Thu Dec 05 00:36:22 2013 +0400
+++ b/jmh-core/src/main/java/org/openjdk/jmh/annotations/AuxCounters.java	Thu Dec 05 00:50:26 2013 +0400
@@ -34,9 +34,14 @@
  * {int, long} values, and treat their values as the operation counts in current
  * iteration.
  * <p>
- * Currently allowed only at {@link Scope#Thread} level, because JMH metric
+ * NOTE: Currently allowed only at {@link Scope#Thread} level, because JMH metric
  * aggregator expects the distinct counters coming from every measurement thread.
  * <p>
+ * NOTE: The counter names are plain field/method names. The namespace for counters
+ * is shared across all states participating in the run. JMH will fail to compile
+ * the benchmark if there is an ambiguity around what counter comes from what
+ * state class.
+ * <p>
  * NOTE: You have to explicitly reset the state if you don't want the counters
  * to be shared across the iterations.
  * <p>