raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

chore: clarify the JMH Readme (#1025)

Browse source 
* chore: clarify the JMH Readme

* chore: typo fix

* follow the real-world execution

* add jmh links

* change the command prefix

* migrate to new syntax
This commit is contained in:
AndyChen 2024-01-23 21:00:54 +08:00 • committed by GitHub
parent 0c01ab4242
commit 27b86bef11
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
bench-jmh/README.md
View file

@ -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: