Author: vsiveton
Date: Thu Jan 17 16:10:11 2008
New Revision: 613016
URL: http://svn.apache.org/viewvc?rev=613016&view=rev
Log:
MNG-3364: Path documentation is not excact in "Getting Started in 5 Minutes"
o updated the installation instructions and the 5 Minutes guide
Modified:
maven/site/trunk/src/site/apt/download.apt.vm
maven/site/trunk/src/site/apt/guides/getting-started/maven-in-five-minutes.apt
Modified: maven/site/trunk/src/site/apt/download.apt.vm
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/download.apt.vm?rev=613016&r1=613015&r2=613016&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/download.apt.vm (original)
+++ maven/site/trunk/src/site/apt/download.apt.vm Thu Jan 17 16:10:11 2008
@@ -50,32 +50,49 @@
* {Installation} Instructions
+ <Maven is a Java tool, so you must have {{{http://java.sun.com}Java}}
installed in order to proceed.>
+
** Windows 2000/XP
- [[1]] Unzip <<<apache-maven-${currentVersion}-bin.zip>>> to the directory
you wish to install Maven ${currentVersion}. These instructions
- assume you chose <<<C:\Program Files\Apache Software
Foundation\apache-maven-${currentVersion}>>>
+ [[1]] Unzip the distribution archive, i.e.
<<<apache-maven-${currentVersion}-bin.zip>>> to the directory you wish to
install Maven ${currentVersion}.
+ These instructions assume you chose <<<"C:\Program Files\Apache
Software Foundation\apache-maven-${currentVersion}">>>.
+ The directory <<<apache-maven-${currentVersion}>>> will be created
from the archive.
+
+ [[2]] Add the <<<M2_HOME>>> environment variable by opening up the system
properties (WinKey + Pause),
+ selecting the "Advanced" tab, and the "Environment Variables" button,
then adding the <<<M2_HOME>>>
+ variable in the user variables with the value
+ <<<"C:\Program Files\Apache Software
Foundation\apache-maven-${currentVersion}">>>. <<Note>>: for Maven \< 2.0.9, be
sure that the <<<M2_HOME>>>
+ doesn't have a '\' as last character.
+
+ [[3]] In the same dialog, add the <<<M2>>> environment variable in the user
variables with the value <<<"%M2_HOME%\bin">>>.
- [[2]] Add the <<<bin>>> directory to your path, by opening up the system
properties (WinKey + Pause),
- selecting the "Advanced" tab, and the "Environment Variables" button,
then editing the <<<PATH>>>
- variable in the user variables. eg.
- <<<"C:\Program Files\Apache Software
Foundation\apache-maven-${currentVersion}\bin";%PATH%>>>
+ [[4]] <<Optional>>: in the same dialog, add the <<<MAVEN_OPTS>>> environment
variable in the user variables to specify JVM properties, e.g. the value
+ <<<"-Xms256m -Xmx512m">>>. This environment variable can be used to
supply extra options to Maven.
- [[3]] In the same dialog, make sure that <<<JAVA_HOME>>> is set to the
location of your JDK,
- eg. <<<C:\Program Files\Java\jdk1.5.0_02>>>
+ [[5]] In the same dialog, update/create the <<<Path>>> environment variable
in the user variables with the value <<<"%M2%;%Path%">>> to add
+ maven available in the command line.
- [[4]] Run <<<mvn --version>>> to verify that it is correctly installed.
+ [[6]] In the same dialog, make sure that <<<JAVA_HOME>>> exists in your user
variables or in the system variables and it is set to the location of your JDK,
+ e.g. <<<"C:\Program Files\Java\jdk1.5.0_02">>> and that
<<<"%JAVA_HOME%\bin">>> is in your <<<Path>>> environment variable.
+
+ [[7]] Open a new command prompt (Winkey + R then type <<<"cmd">>>) and run
<<<"mvn --version">>> to verify that it is correctly installed.
** Unix-based Operating Systems (Linux, Solaris and Mac OS X)
- [[1]] Extract the distribution archive to the directory you wish to install
Maven ${currentVersion}. These instructions
- assume you chose <<</usr/local/apache-maven-${currentVersion}>>>. The
directory <<<apache-maven-${currentVersion}>>> will be created from
- the archive.
+ [[1]] Extract the distribution archive, i.e.
<<<apache-maven-${currentVersion}-bin.tar.gz>>> to the directory you wish to
install Maven ${currentVersion}.
+ These instructions assume you chose
<<<"/usr/local/apache-maven-${currentVersion}">>>. The directory
<<<apache-maven-${currentVersion}>>> will
+ be created from the archive.
+
+ [[2]] In a command terminal, add the <<<M2_HOME>>> environment variable,
e.g. <<<"export M2_HOME=/usr/local/apache-maven-${currentVersion}">>>.
+
+ [[3]] Add the <<<M2>>> environment variable, e.g. <<<"export
M2=$M2_HOME/bin">>>.
- [[2]] Add the <<<bin>>> directory to your path, eg. <<<export
-PATH=/usr/local/apache-maven-${currentVersion}/bin:$PATH>>>
+ [[4]] <<Optional>>: add the <<<MAVEN_OPTS>>> environment variable to specify
JVM properties, e.g. <<<"export MAVEN_OPTS=-Xms256m -Xmx512m">>>.
+ This environment variable can be used to supply extra options to Maven.
- [[3]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, eg.
- <<<export JAVA_HOME=/usr/java/jdk1.5.0_02>>>
+ [[5]] Add <<<M2>>> environment variable to your path, e.g. <<<"export
PATH=$M2:$PATH">>>.
- [[4]] Run <<<mvn --version>>> to verify that it is correctly installed.
+ [[6]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, e.g.
+ <<<"export JAVA_HOME=/usr/java/jdk1.5.0_02">>> and that
<<<"$JAVA_HOME/bin">>> is in your <<<PATH>>> environment variable.
+ [[7]] Run <<<"mvn --version">>> to verify that it is correctly installed.
Modified:
maven/site/trunk/src/site/apt/guides/getting-started/maven-in-five-minutes.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/getting-started/maven-in-five-minutes.apt?rev=613016&r1=613015&r2=613016&view=diff
==============================================================================
---
maven/site/trunk/src/site/apt/guides/getting-started/maven-in-five-minutes.apt
(original)
+++
maven/site/trunk/src/site/apt/guides/getting-started/maven-in-five-minutes.apt
Thu Jan 17 16:10:11 2008
@@ -3,18 +3,17 @@
-----
Eric Redmond
-----
- 14 September 2006
+ January 2008
-----
Maven in 5 Minutes
* Installation
- <Maven is a Java tool, so you must have {{{http://java.sun.com}Java}}
installed in order to proceed>
+ <Maven is a Java tool, so you must have {{{http://java.sun.com}Java}}
installed in order to proceed.>
- First, {{{/download.html}download Maven}} and unzip it to your desired
installation directory, for example
- <<<C:\\maven>>> in windows, or <<</usr/local/maven>>> in Linux. After this,
add the system variable M2_HOME
- as well as the $M2_HOME/bin directory to your system path. Type the
following in a terminal or command prompt:
+ First, {{{../../download.html}download Maven}} and follow the
{{{../../download.html#Installation}installation instructions}}.
+ After that, type the following in a terminal or in a command prompt:
------
mvn --version
@@ -23,7 +22,9 @@
It should print out your installed version of Maven, for example:
------
- Maven version: 2.0.4
+Maven version: 2.0.8
+Java version: 1.5.0_12
+OS name: "windows 2003" version: "5.2" arch: "x86" Family: "windows"
------
Depending upon your network setup, you may require extra configuration.
Check out the
@@ -31,7 +32,7 @@
* Creating a Project
- On your command line, execute the following maven goal:
+ On your command line, execute the following Maven goal:
-------
mvn archetype:create -DgroupId=com.mycompany.app -DartifactId=my-app
@@ -47,9 +48,9 @@
-------
cd my-app
--------
+-------
- Under this directory you will notice the following
+ Under this directory you will notice the following
{{{../introduction/introduction-to-the-standard-directory-layout.html}standard
project structure}}.
-------
@@ -79,7 +80,7 @@
file that contains the majority of information required to build a project
in just the way you want.
The POM is huge and can be daunting in its complexity, but it is not
necessary to understand all
of the intricacies just yet to use it effectively. This project's POM is:
-
+
------
<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
@@ -99,18 +100,16 @@
</dependency>
</dependencies>
</project>
-------
-
-
+------
** What did I just do?
-
- You executed the Maven goal <archetype:create>, and passed in various
parameters to that goal.
- The prefix <archetype> is the {{{/plugins/index.html}plugin}} that contains
the goal. If you are familiar with
+
+ You executed the Maven goal <archetype:create>, and passed in various
parameters to that goal.
+ The prefix <archetype> is the {{{/plugins/index.html}plugin}} that contains
the goal. If you are familiar with
{{{http://ant.apache.org}Ant}}, you
may concieve of this as similar to a task. This goal created a simple
project based upon an archetype.
Suffice it to say for now that a <plugin> is a collection
- of <goals> with a general common purpose. For example the
jboss-maven-plugin, whose purpose is "deal with
+ of <goals> with a general common purpose. For example the
jboss-maven-plugin, whose purpose is "deal with
various jboss items".
** Build the Project
@@ -138,7 +137,7 @@
sequence of phases. When a phase is given, Maven will execute every phase in
the sequence
up to and including the one defined. For example, if we execute the
<compile> phase, the
phases that actually get executed are:
-
+
[[1]] validate
[[2]] generate-sources
@@ -170,7 +169,7 @@
** Maven Phases
Although hardly a comprehensive list, these are the most common <default>
lifecycle phases executed.
-
+
* <<validate>>: validate the project is correct and all necessary
information is available
* <<compile>>: compile the source code of the project
@@ -190,13 +189,13 @@
[]
There are two other Maven lifecycles of note beyond the <default> list
above. They are
-
+
* <<clean>>: cleans up artifacts created by prior builds
-
+
[]
-
+
* <<site>>: generates site documentation for this project
-
+
[]
Phases are actually mapped to underlying goals. The specific goals executed
per phase is dependant upon the
@@ -204,7 +203,7 @@
<war:war> is the project type is - you guessed it - a WAR.
An interesting thing to note is that phases and goals may be executed in
sequence.
-
+
------
mvn clean dependency:copy-dependencies package
------
