Skip to content

Commit b6bc7c0

Browse files
committed
Add example to JAVA_OPTS framework documentation
Previously, the documentation for the JAVA_OPTS framework wasn't clear enough that a user could properly configure it without help. This change adds an example to that documentation to make it clearer. [#69514724][resolves #49]
1 parent 31f14bb commit b6bc7c0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/framework-java_opts.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,14 @@ The framework can be configured by creating or modifying the [`config/java_opts.
2525
| `from_environment` | Whether to append the value of the `JAVA_OPTS` environment variable to the collection of Java options
2626
| `java_opts` | The Java options to use when running the application. All values are used without modification when invoking the JVM. The options are specified as a single YAML scalar in plain style or enclosed in single or double quotes.
2727

28+
29+
## Example
30+
```yaml
31+
# JAVA_OPTS configuration
32+
---
33+
from_environment: false
34+
java_opts: -Xloggc:$PWD/beacon_gc.log -verbose:gc
35+
```
36+
2837
[Configuration and Extension]: ../README.md#configuration-and-extension
2938
[`config/java_opts.yml`]: ../config/java_opts.yml

0 commit comments

Comments
 (0)