Document how to set non-default library paths

[lttng-ust-java-tests.git] / README.md

diff --git a/README.md b/README.md
index c30e7f3f09363c4de9812e897c0ec621a9652489..1bd43fd3244a81240ad6a837875dea489080f6e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,7 +55,31 @@ Please make sure you have no `lttng` session active prior to or during the
 tests, or it might interfere with the test runs!
 
 Detailed JUnit test reports will be available under
 tests, or it might interfere with the test runs!
 
 Detailed JUnit test reports will be available under

-`lttng-ust-java-tests/target/failsafe-reports/`
+`lttng-ust-java-tests-{jul|log4j}/target/failsafe-reports/`
+
+
+Setting library paths
+---------------------
+
+By default, the tests will look for the Java and JNI libraries in the default
+locations of `make install` (`/usr/local/lib`, `/usr/local/share/java`, etc.)
+
+If for example, you installed into the `/usr` prefix instead of `/usr/local`,
+you can use the following properties to specify different locations for the
+lttng-ust-agent-java jars:
+
+    mvn clean verify
+    -Dcommon-jar-location=/usr/share/java/lttng-ust-agent-common.jar
+    -Djul-jar-location=/usr/share/java/lttng-ust-agent-jul.jar
+    -Dlog4j-jar-location=/usr/share/java/lttng-ust-agent-log4j.jar
+
+To specify a different locations for the JNI .so libraries, you can set the
+`-Djava.library.path` property on the JVM:
+
+    mvn (...) -DargLine=-Djava.library.path=/usr/lib
+
+Note: do not use `MAVEN_OPTS` to set the library path, since the `argLine`
+property defined in the build will overwrite it.

 
 
 Running the benchmarks
 
 
 Running the benchmarks