github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 09:28:55 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix docs for passing JVM args to ./gradlew run (#81253)

Browse source 
The instructions in `TESTING.asciidoc` for how to disable assertions
when running `./gradlew run` didn't work. Fix the docs by describing
how to pass JVM args, using disabling assertions as an example.
This commit is contained in:
Rory Hunter 2021-12-03 09:16:23 +00:00 • committed by GitHub
parent e7e7a1401e
commit a7fdb08046
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
TESTING.asciidoc
View file

@ -64,6 +64,15 @@ NOTE: If you have imported the project into IntelliJ according to the instructio
link:/CONTRIBUTING.md#importing-the-project-into-intellij-idea[CONTRIBUTING.md] then a debug run configuration link:/CONTRIBUTING.md#importing-the-project-into-intellij-idea[CONTRIBUTING.md] then a debug run configuration
named "Debug Elasticsearch" will be created for you and configured appropriately. named "Debug Elasticsearch" will be created for you and configured appropriately.
==== Disabling assertions
When running Elasticsearch with `./gradlew run`, assertions are enabled by
default. To disable them, add the following command line option:
-------------------------
-Dtests.jvm.argline="-da"
-------------------------
==== Distribution ==== Distribution
By default a node is started with the zip distribution. By default a node is started with the zip distribution.
@ -92,12 +101,12 @@ password: `elastic-password`.
==== Other useful arguments ==== Other useful arguments
- In order to start a node with a different max heap space add: `-Dtests.heap.size=4G` - In order to start a node with a different max heap space add: `-Dtests.heap.size=4G`
- In order to disable assertions add: `-Dtests.asserts=false`
- In order to use a custom data directory: `--data-dir=/tmp/foo` - In order to use a custom data directory: `--data-dir=/tmp/foo`
- In order to preserve data in between executions: `--preserve-data` - In order to preserve data in between executions: `--preserve-data`
- In order to remotely attach a debugger to the process: `--debug-jvm` - In order to remotely attach a debugger to the process: `--debug-jvm`
- In order to set a different keystore password: `--keystore-password` - In order to set a different keystore password: `--keystore-password`
- In order to set an Elasticsearch setting, provide a setting with the following prefix: `-Dtests.es.` - In order to set an Elasticsearch setting, provide a setting with the following prefix: `-Dtests.es.`
- In order to pass a JVM seting, e.g. to disable assertions: `-Dtests.jvm.argline="-da"`
=== Test case filtering. === Test case filtering.