Author: brett
Date: Sat May 21 21:56:14 2005
New Revision: 171282
URL: http://svn.apache.org/viewcvs?rev=171282&view=rev
Log:
PR: MAVEN-1067
Submitted by: Jeff Jensen
Reviewed by: Brett Porter
Document MAVEN_OPTS
(applied with modifications)
Modified:
maven/maven-1/core/trunk/xdocs/reference/command-line.xml
Modified: maven/maven-1/core/trunk/xdocs/reference/command-line.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/command-line.xml?rev=171282&r1=171281&r2=171282&view=diff
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/command-line.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/command-line.xml Sat May 21
21:56:14 2005
@@ -166,6 +166,35 @@
</td>
</tr>
</table>
+ <subsection name="MAVEN_OPTS">
+ <p>
+ Specify additional options using the <code>MAVEN_OPTS</code>
environment variable.
+ It is for passing parameters to the Java VM when running Maven.
+ For example, to increase the amount of memory to 1024 Meg for the
entire run of Maven, use:
+ </p>
+ <source>MAVEN_OPTS=-Xmx1024m</source>
+ <p>
+ Also note that a given plug-in may have a property to set for its
memory usage,
+ such as the Javadoc plug-in's <code>maven.javadoc.maxmemory</code>
property.
+ This is because that particular plugin forks an additional Java VM.
+ </p>
+ <p>
+ For another example, set the MAVEN_OPTS to run Java in debug mode:
+ </p>
+ <source>MAVEN_OPTS=-Xdebug
-Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=y</source>
+ <p>
+ After setting this property, run "maven cactus:test" (or whatever
goal to debug)
+ and it will block, waiting for a debug connection.
+ </p>
+ <p>
+ Then, in your IDE, select the "Run -> Debug" window and craete a new
"Remote Java Application"
+ configuration, passing the port set in MAVEN_OPTS (8787 in this
case).
+ </p>
+ <p>
+ Once running this configuration in debug, the blocked Maven session
will continue, enabling
+ debugging from your IDE.
+ </p>
+ </subsection>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
