changeset 938:069fd4ea2c8e

samples: add the caveat links for all samples running with Java API from the IDE.
author shade
date Wed, 06 Aug 2014 17:00:43 +0400
parents 1eff4c9d1ab0
children 9b2561a5e071
files jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_01_HelloWorld.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_02_BenchmarkModes.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_03_States.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_04_DefaultState.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_05_StateFixtures.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_06_FixtureLevel.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_07_FixtureLevelInvocation.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_08_DeadCode.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_09_Blackholes.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_10_ConstantFold.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_11_Loops.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_12_Forking.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_13_RunToRun.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_15_Asymmetric.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_16_CompilerControl.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_17_SyncIterations.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_18_Control.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_20_Annotations.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_21_ConsumeCPU.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_22_FalseSharing.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_23_AuxCounters.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_24_Inheritance.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_26_BatchSize.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_27_Params.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_28_BlackholeHelpers.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_29_StatesDAG.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_30_Interrupts.java jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_31_InfraParams.java
diffstat 28 files changed, 59 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_01_HelloWorld.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_01_HelloWorld.java	Wed Aug 06 17:00:43 2014 +0400
@@ -78,7 +78,9 @@
      * The runtime options for the JMH are available with "-h":
      *    $ java -jar target/benchmarks.jar -h
      *
-     * b) Via Java API:
+     * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_02_BenchmarkModes.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_02_BenchmarkModes.java	Wed Aug 06 17:00:43 2014 +0400
@@ -147,6 +147,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_03_States.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_03_States.java	Wed Aug 06 17:00:43 2014 +0400
@@ -104,6 +104,8 @@
      *    (we requested 5 measurement/warmup iterations, with 4 threads, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_04_DefaultState.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_04_DefaultState.java	Wed Aug 06 17:00:43 2014 +0400
@@ -62,6 +62,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_05_StateFixtures.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_05_StateFixtures.java	Wed Aug 06 17:00:43 2014 +0400
@@ -112,6 +112,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_06_FixtureLevel.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_06_FixtureLevel.java	Wed Aug 06 17:00:43 2014 +0400
@@ -86,6 +86,8 @@
      *    You can optionally supply -foe to fail the complete run.
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_07_FixtureLevelInvocation.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_07_FixtureLevelInvocation.java	Wed Aug 06 17:00:43 2014 +0400
@@ -156,6 +156,10 @@
      *    $ mvn clean install
      *    $ java -jar target/benchmarks.jar ".*JMHSample_07.*" -wi 5 -i 5 -f 1
      *    (we requested 5 warmup/measurement iterations, single fork)
+     *
+     * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_08_DeadCode.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_08_DeadCode.java	Wed Aug 06 17:00:43 2014 +0400
@@ -85,6 +85,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_09_Blackholes.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_09_Blackholes.java	Wed Aug 06 17:00:43 2014 +0400
@@ -114,6 +114,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_10_ConstantFold.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_10_ConstantFold.java	Wed Aug 06 17:00:43 2014 +0400
@@ -88,6 +88,8 @@
      *    (we requested 5 iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_11_Loops.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_11_Loops.java	Wed Aug 06 17:00:43 2014 +0400
@@ -142,6 +142,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_12_Forking.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_12_Forking.java	Wed Aug 06 17:00:43 2014 +0400
@@ -170,6 +170,8 @@
      *    (we requested 5 warmup/measurement iterations)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_13_RunToRun.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_13_RunToRun.java	Wed Aug 06 17:00:43 2014 +0400
@@ -106,6 +106,8 @@
      *    (we requested no warmup, 3 measurement iterations)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_15_Asymmetric.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_15_Asymmetric.java	Wed Aug 06 17:00:43 2014 +0400
@@ -105,6 +105,8 @@
      *    (we requested 5 warmup/measurement iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_16_CompilerControl.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_16_CompilerControl.java	Wed Aug 06 17:00:43 2014 +0400
@@ -122,6 +122,8 @@
      *    (we requested 1 warmup iterations, 3 iterations, single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_17_SyncIterations.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_17_SyncIterations.java	Wed Aug 06 17:00:43 2014 +0400
@@ -102,6 +102,8 @@
      *     lots of threads, and changeable "synchronize iterations" option)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_18_Control.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_18_Control.java	Wed Aug 06 17:00:43 2014 +0400
@@ -82,6 +82,8 @@
      *    (we requested 1 warmup iterations, 5 iterations, 2 threads, and single fork)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_20_Annotations.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_20_Annotations.java	Wed Aug 06 17:00:43 2014 +0400
@@ -79,6 +79,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_20.*"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_21_ConsumeCPU.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_21_ConsumeCPU.java	Wed Aug 06 17:00:43 2014 +0400
@@ -125,6 +125,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_21.*" -w 1 -i 5 -f 1
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_22_FalseSharing.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_22_FalseSharing.java	Wed Aug 06 17:00:43 2014 +0400
@@ -228,6 +228,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_22.*" -t $CPU
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_23_AuxCounters.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_23_AuxCounters.java	Wed Aug 06 17:00:43 2014 +0400
@@ -97,6 +97,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_23.*"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_24_Inheritance.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_24_Inheritance.java	Wed Aug 06 17:00:43 2014 +0400
@@ -109,6 +109,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_24.*"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_26_BatchSize.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_26_BatchSize.java	Wed Aug 06 17:00:43 2014 +0400
@@ -117,6 +117,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_26.*" -f 1
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_27_Params.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_27_Params.java	Wed Aug 06 17:00:43 2014 +0400
@@ -81,6 +81,8 @@
      *    You can juggle parameters through the command line, e.g. with "-p arg=41,42"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_28_BlackholeHelpers.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_28_BlackholeHelpers.java	Wed Aug 06 17:00:43 2014 +0400
@@ -129,6 +129,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_28.*"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_29_StatesDAG.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_29_StatesDAG.java	Wed Aug 06 17:00:43 2014 +0400
@@ -149,6 +149,8 @@
      *    $ java -jar target/benchmarks.jar ".*JMHSample_29.*"
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_30_Interrupts.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_30_Interrupts.java	Wed Aug 06 17:00:43 2014 +0400
@@ -93,6 +93,8 @@
      *    (we requested 5 warmup iterations, 5 iterations, 2 threads, and 5 forks)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {
--- a/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_31_InfraParams.java	Wed Aug 06 12:19:16 2014 +0400
+++ b/jmh-samples/src/main/java/org/openjdk/jmh/samples/JMHSample_31_InfraParams.java	Wed Aug 06 17:00:43 2014 +0400
@@ -118,6 +118,8 @@
      *    (we requested 5 warmup iterations, 5 iterations, 2 threads, and 5 forks)
      *
      * b) Via the Java API:
+     *    (see the JMH homepage for possible caveats when running from IDE:
+     *      http://openjdk.java.net/projects/code-tools/jmh/)
      */
 
     public static void main(String[] args) throws RunnerException {