search

quick-perf / quickperf

QuickPerf is a testing library for Java to quickly evaluate and improve some performance-related properties
https://github.com/quick-perf/doc/wiki/QuickPerf
Apache License 2.0
488 stars 65 forks source link

Add Javadoc to JVM annotations #89

Closed jeanbisutti closed 4 years ago

jeanbisutti commented 4 years ago

JVM annotations are documented in QuickPerf wiki.

The goal of this issue is to add Javadoc to JVM annotations that are located in jvm-annotations Maven module.

The documentation contained in QuickPerf wiki can be used to add Javadoc to the JVM annotations. Don't hesitate to improve it.

VinitaNirmal commented 4 years ago

Is the task that, we have to add the comments on top of the annotations??

jeanbisutti commented 4 years ago

Hello,

Javadoc has to be added in the JVM annotations in the same way it is done for SQL annotations, with a package info.

Kind regards,

Jean

FTarfasse commented 4 years ago

Hello Jean,

Is anyone working on this ? I can do it if it is not the case (to finish the topic for once and for all !).

Kind regards, Fabrice

jeanbisutti commented 4 years ago

Hello Fabrice,

Nobody is working on this issue. I assign it to you.

Many thanks for your contributions.

Don't hesitate if you have any questions.

Kind regards,

Jean

FTarfasse commented 4 years ago

Hi Jean,

Sorry for the delay, here's a draft.

Note that for the @ProfileQuickPerfInTestJvm I haven't done anything as I am not confident with the typical use case is. So far I understood it launches the specific JVM with these args: -XX:FlightRecorderOptions=defaultrecording=true,disk=true,settings=profile,dumponexit=true,dumponexitpath=dumponexit.jfr.

Is it the "only thing" to notice about it ?

By the way, I faced this error when launching a test with this annotation, don't know if it is specific to my configuration or not:

org.quickperf.issue.JvmError: [0,038s][error][arguments] -XX:FlightRecorderOptions=settings=... has been removed. Use -XX:StartFlightRecording=settings=... instead. Error occurred during initialization of VM Failure when starting JFR on_create_vm_2

I'd be happy to have your feedbacks once you got some time, I based these Javadocs extensively on the existing documentation this time (I added an article in the @see section of @Xms and @Xmx).

Kind regards, Fabrice

jeanbisutti commented 4 years ago

Hi Fabrice,

Don't worry about the delay. I looked at your draft. It's great, many thanks! I made a few suggestions. Don't hesitate if you have any questions, and don't hesitate to submit a PR!

About, @ProfileQuickPerfInTestJvm there was a bug with JDK > 1.8. Thank you for the report. The aim if this annotation is to profile QuickPerf. It's not a public annotation; it is not needed to document it. The bug is now fixed on head.

Kind regards,

Jean

FTarfasse commented 4 years ago

Hi Jean,

Thanks for your feedbacks ! I added a new commit based on your suggestions as I wanted the corrections to be clear (I'll squash everything for the PR).

Kind regards, Fabrice

jeanbisutti commented 4 years ago

Fixed with 9ab2d8e1b9c548a4f406eda2201632cf4fdabc4d.

Thank you @FTarfasse!