[incubator-plc4x] branch master updated: added basic readme for JMH

[sr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sruehl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git


The following commit(s) were added to refs/heads/master by this push:
     new 967d756  added basic readme for JMH
967d756 is described below

commit 967d756b54e50cb14c77b6aba20872b59f5ad276
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Fri Mar 9 10:56:11 2018 +0100

    added basic readme for JMH
---
 plc4j/protocols/benchmarks/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/plc4j/protocols/benchmarks/README.md b/plc4j/protocols/benchmarks/README.md
new file mode 100644
index 0000000..8735d8c
--- /dev/null
+++ b/plc4j/protocols/benchmarks/README.md
@@ -0,0 +1,12 @@
+The benchmarks module contains micro-benchmarks for multiple protocols.
+
+It uses JMH for benchmarking (http://openjdk.java.net/projects/code-tools/jmh/)
+
+The recommendation from JMH id to run bechmarks in a separate module like this one:
+
+_The recommended way to run a JMH benchmark is to use Maven to setup a standalone project that depends on the jar files of your application. This approach is preferred to ensure that the benchmarks are correctly initialized and produce reliable results. It is possible to run benchmarks from within an existing project, and even from within an IDE, however setup is more complex and the results are less reliable._
+Source: http://openjdk.java.net/projects/code-tools/jmh/
+
+To run the test you can use a plugin for your IDE. If you want to use maven you can use the profile `run-benchmark`:
+
+`mvn -Prun-benchmark verify`
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
sruehl@apache.org.