From eaa6f14475ed53abe05cb131ed742dbf7c4dcd3b Mon Sep 17 00:00:00 2001 From: AndyChen Date: Tue, 23 Jan 2024 10:39:02 +0800 Subject: [PATCH 1/6] chore: clarify the JMH Readme --- bench-jmh/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index 81be2c585ae..7411a6cca34 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -6,8 +6,18 @@ own jmh module) You can run them like: - project bench-jmh - jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +```shell +sbt shell +sbt:pekko> project bench-jmh +sbt:pekko-bench-jmh> jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +``` + +or execute in one line command + +```shell +sbt bench-jmh/jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +``` + Use 'jmh:run -h' to get an overview of the available options. From 0329972747e927c3300e0a94998f68283982b6bd Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Tue, 23 Jan 2024 10:43:24 +0800 Subject: [PATCH 2/6] chore: typo fix --- bench-jmh/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index 7411a6cca34..315ac5f0cca 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -12,7 +12,7 @@ sbt:pekko> project bench-jmh sbt:pekko-bench-jmh> jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` -or execute in one line command +or execute in one-line command ```shell sbt bench-jmh/jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark From 6667e19acb4ff9dffe6ce1058b78da3e078b3b72 Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Tue, 23 Jan 2024 11:04:38 +0800 Subject: [PATCH 3/6] follow the real-world execution --- bench-jmh/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index 315ac5f0cca..bacc94b099e 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -8,7 +8,7 @@ You can run them like: ```shell sbt shell -sbt:pekko> project bench-jmh +pekko > project bench-jmh sbt:pekko-bench-jmh> jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` From de4c7de10e833bd5bce53a9fb979e8ec8be6cb55 Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Tue, 23 Jan 2024 11:24:45 +0800 Subject: [PATCH 4/6] add jmh links --- bench-jmh/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index bacc94b099e..b649ed17991 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -4,18 +4,18 @@ This subproject contains some microbenchmarks excercising key parts of Apache Pe own jmh module) -You can run them like: +Pekko uses [sbt-jmh](https://github.com/sbt/sbt-jmh) to integrate [Java Microbenchmark Harness](https://github.com/openjdk/jmh). You can run them like: ```shell sbt shell pekko > project bench-jmh -sbt:pekko-bench-jmh> jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +sbt:bench-jmh> Jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` or execute in one-line command ```shell -sbt bench-jmh/jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +sbt bench-jmh/Jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` From de1019bb3c22ec4824a1efa33fe7fb150b3ad64a Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Tue, 23 Jan 2024 11:33:27 +0800 Subject: [PATCH 5/6] change the command prefix --- bench-jmh/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index b649ed17991..00286185173 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -19,7 +19,7 @@ sbt bench-jmh/Jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` -Use 'jmh:run -h' to get an overview of the available options. +Use 'Jmh:run -h' to get an overview of the available options. Some potentially out of date resources for writing JMH benchmarks: From 0a9e843404fb4eb1b4196b9ecf608d5ffc6e0cab Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Tue, 23 Jan 2024 18:30:46 +0800 Subject: [PATCH 6/6] migrate to new syntax --- bench-jmh/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index 00286185173..df4709fcaf7 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -9,17 +9,17 @@ Pekko uses [sbt-jmh](https://github.com/sbt/sbt-jmh) to integrate [Java Microben ```shell sbt shell pekko > project bench-jmh -sbt:bench-jmh> Jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +sbt:bench-jmh> Jmh/run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` or execute in one-line command ```shell -sbt bench-jmh/Jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +sbt bench-jmh/Jmh/run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark ``` -Use 'Jmh:run -h' to get an overview of the available options. +Use 'Jmh/run -h' to get an overview of the available options. Some potentially out of date resources for writing JMH benchmarks: