Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve sample projects #183

Open
15 tasks
qurbonzoda opened this issue Jan 25, 2024 · 0 comments
Open
15 tasks

Improve sample projects #183

qurbonzoda opened this issue Jan 25, 2024 · 0 comments

Comments

@qurbonzoda
Copy link
Collaborator

qurbonzoda commented Jan 25, 2024

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 jmhVersion is specified, including with benchmarks_jmh_version project property.
  • Configure the main configuration profile to demonstrate:
    • Options override annotations in benchmark code
    • Time unit string formats supported
    • Benchmark mode option impact
    • reportFormat option usage and the reports of different formats
    • param option usage
    • advanced option 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-benchmark plugin creates
  • Use Kotlin DSL in the Gradle build script

Make sure to reference those project from the relevant guides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant