ravn commented on code in PR #308:
URL: https://github.com/apache/maven-site/pull/308#discussion_r912551491
##########
content/markdown/configure.md:
##########
@@ -17,42 +17,107 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
-The configuration for Apache Maven usage itself and projects built with
resides
-in a number of places:
-## `MAVEN_OPTS` environment variable:
+Apache Maven ships with two launcher commands in the `${MAVEN_HOME}/bin`
folder,
+which - based on several environment variables, project files and system files
as described below
+- constructs and runs the appropriate `java ...` command line which then
invokes the Java Virtual Machine (JVM)
+that actually runs Maven.
-This variable contains parameters used to start up the JVM running Maven and
-can be used to supply additional options to it. E.g. JVM memory
-settings could be defined with the value `-Xms256m -Xmx512m`.
+* `mvn` - normal way to run from the command line.
+* `mvnDebug` - launches `mvn` in debug mode, waiting for a Java debugger to
attach to port `$MAVEN_DEBUG_ADDRESS` (default 8000).
-## `MAVEN_ARGS` environment variable:
+
+## Environment variables
+
+In the following the Unix syntax for environment variables is used in the text.
+
+For Windows the syntax is slightly different, for `$A` use `%A%`.
+
+### `$MAVEN_OPTS` - `%MAVEN_OPTS%`
+
+The contents of this variable is placed in the `java` command _before_ the
class name, and
+can therefore be used to provide additional arguments to the Java Virtual
Machine (JVM) without
+having to specify them on the command line every time.
+
+Examples include garbage collector and memory configuration, but _not_ options
to Maven itself
+
+Use `java --help` and `java -X` to see what is possible in this particular JVM.
+
+<!--
+### `$MAVEN_ARGS`
Starting with Maven 4, this variable contains arguments passed to Maven before
CLI arguments. E.g., options and goals could be defined with the value
`-B -V checkstyle:checkstyle`.
+-->
+
+### `$MAVEN_BASEDIR` - `%MAVEN_BASEDIR%`
Review Comment:
Oh, this is about MAVEN_BASEDIR which is a thing in the current wrappers.
Should it not be documented until maven 4 is released?
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
