aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFabian Meumertzheim <meumertzheim@code-intelligence.com>2021-11-22 10:51:21 +0100
committerFabian Meumertzheim <fabian@meumertzhe.im>2021-11-22 14:55:25 +0100
commitfdc1c2493ab7e97e4ce858077e5b8cf4908f3609 (patch)
treefb14431065e879d5a2d0de5d3d1430c423cf4ccf /README.md
parent3b7fc14337f285eb63683183a8478d664a455f39 (diff)
downloadjazzer-api-fdc1c2493ab7e97e4ce858077e5b8cf4908f3609.tar.gz
Document `--jvm_args` in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2cfff2db..f8b08d1a 100644
--- a/README.md
+++ b/README.md
@@ -389,6 +389,19 @@ Jazzer options are passed via double dash command-line flags, i.e., as `--option
A full list of command-line flags can be printed with the `--help` flag. For the available libFuzzer options please refer
to [its documentation](https://llvm.org/docs/LibFuzzer.html) for a detailed description.
+### Passing JVM arguments
+
+Arguments for the JVM started by Jazzer can be supplied via the `--jvm_args` argument.
+Multiple arguments are delimited by the classpath separator, which is `;` on Windows and `:` else.
+For example, to enable preview features as well as set a maximum heap size, add the following to the Jazzer invocation:
+
+```bash
+# Windows
+--jvm_args=--enable-preview;-Xmx1000m
+# Linux & macOS
+--jvm_args=--enable-preview:-Xmx1000m
+```
+
### Coverage Instrumentation
The Jazzer agent inserts coverage markers into the JVM bytecode during class loading. libFuzzer uses this information