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

Add elasticsearch- prefix to CLI tool docs (#101626)

Browse source 
The tools are called `elasticsearch-shard` and `elasticsearch-node` and
so on, but in the docs about their JVM options the `elasticsearch-`
prefix is omitted. This commit fixes that.
This commit is contained in:
David Turner 2023-10-31 17:27:03 +00:00 • committed by GitHub
parent d94f0a4792
commit 885b436acf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/reference/commands/cli-jvm-options.asciidoc
View file

@ -2,9 +2,10 @@
[float]
==== JVM options
CLI tools run with 64MB of heap. For most tools, this value is fine. However, if needed
this can be overriden by setting the CLI_JAVA_OPTS environment variable. For example,
the following increases the heap size used by the `pass:a[{tool-name}]` tool to 1GB.
CLI tools run with 64MB of heap. For most tools, this value is fine. However, if
needed this can be overriden by setting the `CLI_JAVA_OPTS` environment variable.
For example, the following increases the heap size used by the
`pass:a[elasticsearch-{tool-name}]` tool to 1GB.
[source,shell,subs=attributes+]
--------------------------------------------------