kotlinx-benchmark
kotlinx-benchmark copied to clipboard
Improve sample projects
trafficstars
Sample projects are meant to showcase the library features and possible configurations. Current example projects do not cover all of them.
Introduce sample projects for:
- [ ] Kotlin Mutiplatform project where the benchmark code is within the main compilation of Kotlin targets
- [ ] Kotlin Mutiplatform project where the benchmark code is separated from the main compilation of Kotlin targets
- [ ] Kotlin/JVM and Java projects where the benchmark code is within the main source set of the project
- [ ] Kotlin/JVM and Java projects where the benchmark code is separated from the main source set of the project
- [ ] Kotlin Mutiplatform project where Kotlin/JS or Wasm benchmarks are executed with the built-in executor
- [ ] Kotlin Mutiplatform, Kotlin/JVM and Java projects where
jmhVersionis specified, including withbenchmarks_jmh_versionproject property. - [ ] Configure the main configuration profile to demonstrate:
- [ ] Options override annotations in benchmark code
- [ ] Time unit string formats supported
- [ ] Benchmark
modeoption impact - [ ]
reportFormatoption usage and the reports of different formats - [ ]
paramoption usage - [ ]
advancedoption usage
- [ ] Create and configure additional configuration profiles
- [ ] Include and exclude benchmarks
The introduced samples should:
- Document what does the project demonstrates
- Document relevant tasks the
kotlinx-benchmarkplugin creates - Use Kotlin DSL in the Gradle build script
Make sure to reference those project from the relevant guides.