bitflicker64 commented on code in PR #509:
URL: https://github.com/apache/hugegraph-doc/pull/509#discussion_r4230988263


##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -535,6 +535,25 @@ This indicates the successful creation of the sample graph.
 
 `bin/stop-hugegraph.sh` accepts `-m true|false` (default `true`), which 
controls whether the cron monitor task is removed along with the service.
 
+`bin/hugegraph-server.sh` puts `-XX:+HeapDumpOnOutOfMemoryError`, 
`-XX:HeapDumpPath` and `-XX:ErrorFile` first in `JAVA_TOOL_OPTIONS`, so whether 
or not

Review Comment:
   Minor: "whether or not `JAVA_OPTIONS` is set, an out-of-memory heap dump ... 
and a JVM crash log ... land in `logs/`" is unconditional, but the launcher in 
apache/hugegraph#3258 (head adafb74e8) skips these defaults entirely when the 
`logs/` path contains a double quote or `%`: the `case "${LOGS}" in *\"*|*%*)` 
branch in `hugegraph-server.sh` only calls `report_error "WARN: ${LOGS} 
contains a double quote or %, so the heap dump and crash log defaults are not 
set; set -XX:HeapDumpPath and -XX:ErrorFile yourself"` and never exports 
`JAVA_TOOL_OPTIONS`. An operator whose install path has one of those characters 
finds no `heapdump_*` directory, no `hs_err_pid*_<host>_<launch time>.log`, and 
no `Picked up JAVA_TOOL_OPTIONS` line, with nothing on this page explaining 
why. Please add one sentence, for example: "If the install path contains `\"` 
or `%`, the launcher sets none of these defaults and logs a WARN; set 
`-XX:HeapDumpPath` and `-XX:ErrorFile` yourself." The CN page (line 539) ne
 eds the same sentence.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to