From 27b86bef117194968c542073fa03bee55528670e Mon Sep 17 00:00:00 2001 From: AndyChen Date: Tue, 23 Jan 2024 21:00:54 +0800 Subject: [PATCH] chore: clarify the JMH Readme (#1025) * chore: clarify the JMH Readme * chore: typo fix * follow the real-world execution * add jmh links * change the command prefix * migrate to new syntax --- bench-jmh/README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/bench-jmh/README.md b/bench-jmh/README.md index 81be2c585ae..df4709fcaf7 100644 --- a/bench-jmh/README.md +++ b/bench-jmh/README.md @@ -4,12 +4,22 @@ 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: - project bench-jmh - jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +```shell +sbt shell +pekko > project bench-jmh +sbt:bench-jmh> Jmh/run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark +``` -Use 'jmh:run -h' to get an overview of the available options. +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. Some potentially out of date resources for writing JMH benchmarks: