Skip to content

Commit

Permalink
chore: clarify the JMH Readme (#1025)
Browse files Browse the repository at this point in the history
* chore: clarify the JMH Readme

* chore: typo fix

* follow the real-world execution

* add jmh links

* change the command prefix

* migrate to new syntax
  • Loading branch information
Roiocam authored Jan 23, 2024
1 parent 0c01ab4 commit 27b86be
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions bench-jmh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 27b86be

Please sign in to comment.