Skip to content

Commit

Permalink
Add elasticsearch- prefix to CLI tool docs (elastic#101626)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
DaveCTurner authored Oct 31, 2023
1 parent d94f0a4 commit 885b436
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/reference/commands/cli-jvm-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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+]
--------------------------------------------------
Expand Down

0 comments on commit 885b436

Please sign in to comment.