Skip to content

Commit

Permalink
Clarify the instructions for passing JVM parameters into the Docker c…
Browse files Browse the repository at this point in the history
…ontainer
  • Loading branch information
mfitz committed May 10, 2024
1 parent b96ed09 commit 6362ca0
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,8 +327,15 @@ gelato \
-o /gelato-out
```

You will sometimes want to set more than one JVM parameter. You do this by making a space-separated list
inside the JVM_OPTS value string, for example:

```shell
-e JVM_OPTS="-Xmx100G -XX:+UseParallelGC -XX:+HeapDumpOnOutOfMemoryError -XX:+PrintFlagsFinal"
```

(The `-XX:+PrintFlagsFinal` param does not modify memory configuration, but instructs the JVM to dump all of
its settings to the console on startup. That can be handy when you want to confirm that the memory settings
its settings to the console on startup. That can be handy when you want to confirm at runtime that the memory settings
are as you expect.)


Expand Down

0 comments on commit 6362ca0

Please sign in to comment.