apache / apache/grails-core

No documentation on JVM parameters for CLI

Open
#14,187 2 comments 0 reactions 0 assignees View on GitHub
relates-to: documentation
Dominant language
Groovy
Stars
2.9k
Forks
975
Avg merge
1d 22h
Merged PRs (30d)
92

Description

Latest docs do not have any documentation on how to add JVM parameters to the CLI interface. If they do, I've been unable to find them with terms I'd expect to use.

Compare [latest](//grails.github.io/grails-doc/latest/guide/commandLine.html) to [2.3.x](//grails.github.io/grails-doc/2.3.x/guide/commandLine.html).

Notably, words like `memory` `jvm` `system property` should be included in the description, for searchability. I'd also recommend `GRAILS_OPTS`, as that was applicable for 2.3.x environments.

If it's no longer supported, that information should be accessible in the [upgrading](//grails.github.io/grails-doc/latest/guide/upgrading.html).

The closest I've found was searching for system properties, which yielded the page on [`run-app`](//grails.github.io/grails-doc/latest/ref/Command%20Line/run-app.html). I tested the `server.port` example and it did nothing. I attempted `grails.server.port.http` but that led to a cryptic error, which I'm not prepared to investigate.

Contributor guide

Open the contributing guide

Research direction

Compare the latest and 2.3.x guide/commandLine.html pages, then review the run-app and upgrading documentation linked in the issue. Determine whether JVM parameters and GRAILS_OPTS are supported; document the supported usage and searchable terms, or explain the removal in upgrading.html.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.