This is an automated email from the ASF dual-hosted git repository.
hepin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 27b86bef11 chore: clarify the JMH Readme (#1025)
27b86bef11 is described below
commit 27b86bef117194968c542073fa03bee55528670e
Author: AndyChen <[email protected]>
AuthorDate: Tue Jan 23 21:00:54 2024 +0800
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 81be2c585a..df4709fcaf 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:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
