You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jt...@apache.org on 2002/03/26 02:04:30 UTC
cvs commit: jakarta-turbine-maven/xdocs bootstrap.xml build-file.xml getting-started.xml project-descriptor.xml
jtaylor 02/03/25 17:04:30
Modified: xdocs bootstrap.xml build-file.xml getting-started.xml
project-descriptor.xml
Log:
Removing excess whitespace inside source elements. This should fix some
layout problems on the site (and will layout better in fo / pdf when that
is complete).
Revision Changes Path
1.13 +15 -25 jakarta-turbine-maven/xdocs/bootstrap.xml
Index: bootstrap.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/bootstrap.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- bootstrap.xml 24 Mar 2002 13:57:53 -0000 1.12
+++ bootstrap.xml 26 Mar 2002 01:04:29 -0000 1.13
@@ -24,12 +24,10 @@
and optionally <code>${maven.home}</code> defined in your
${user.home}/build properties):
</p>
- <source><![CDATA[
- ant -f build-bootstrap.xml update-jars
- ant -f build-bootstrap.xml
- ant maven:update-jars
- ant maven:jar
- ]]></source>
+ <source><![CDATA[ant -f build-bootstrap.xml update-jars
+ant -f build-bootstrap.xml
+ant maven:update-jars
+ant maven:jar]]></source>
<p/>
<subsection name="Bootstrapping Maven">
<p>
@@ -42,15 +40,13 @@
Next, you must define the <code>${lib.repo}</code> property in
your <code>${user.home}/build.properties</code> file. You
should also define <code>${maven.home}</code> here as well.
- If you do not have a <code>${user.home}/build.properties</code>
+ If you do not have a <code>${user.home}/build.properties</code>
file, create one in your home directory and add the following
lines:
</p>
- <source><![CDATA[
- lib.repo = /path/to/some/directory
- maven.home = /path/to/some/other/directory
- ]]></source>
- <p>
+ <source><![CDATA[lib.repo = /path/to/some/directory
+maven.home = /path/to/some/other/directory]]></source>
+ <p>
The value of <code>${lib.repo}</code> property determines the
location that the dependencies will be stored after they have
been downloaded. Note: this directory must already exist in
@@ -65,16 +61,12 @@
automatically. Type the following to automatically download
the required jars:
</p>
- <source><![CDATA[
- ant -f build-bootstrap.xml update-jars
- ]]></source>
+ <source><![CDATA[ant -f build-bootstrap.xml update-jars]]></source>
<p>
After you've downloaded all of the dependencies, bootstrapping
is very easy. Type the following:
</p>
- <source><![CDATA[
- ant -f build-bootstrap.xml
- ]]></source>
+ <source><![CDATA[ant -f build-bootstrap.xml]]></source>
</subsection>
<subsection name="Building Maven with Maven">
<p>
@@ -89,10 +81,8 @@
complete the building of maven using the build system that was
generated, type the following:
</p>
- <source><![CDATA[
- ant maven:update-jars
- ant maven:jar
- ]]></source>
+ <source><![CDATA[ant maven:update-jars
+ant maven:jar]]></source>
<p>
Thats it! You have now built Maven with Maven (and partially
installed Maven)! You can find the Maven jar file in the
@@ -106,10 +96,10 @@
</p>
<p>
<b>Note:</b> If your Maven build fails at this point then you
- may need to add a copy of junit.jar to your
- <code>${ant.home}/lib</code> directory. This is a known
+ may need to add a copy of junit.jar to your
+ <code>${ant.home}/lib</code> directory. This is a known
problem that is currently being worked on, but for now you
- can download a copy of the JUnit jar from
+ can download a copy of the JUnit jar from
<a href="http://jakarta.apache.org/turbine/jars">here.</a>
</p>
<p>
1.18 +34 -36 jakarta-turbine-maven/xdocs/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/build-file.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- build-file.xml 22 Mar 2002 19:03:01 -0000 1.17
+++ build-file.xml 26 Mar 2002 01:04:29 -0000 1.18
@@ -12,7 +12,7 @@
Maven utilizes <a href="http://jakarta.apache.org/ant">Ant</a>
to provide users with an easy-to-use and familiar interface to
manage projects that have been described with a valid Maven <a
- href="project-descriptor.html">project descriptor</a>.
+ href="project-descriptor.html">project descriptor</a>.
The build files that Maven <a href="getting-started.html">
installs</a> are stored in <code>${maven.home}</code> directory.
</p>
@@ -47,33 +47,32 @@
example, you could add the following to your
<code>build.xml</code> file to utilize Maven:
</p>
- <source><![CDATA[
-<!-- maven:start -->
+ <source><![CDATA[<!-- maven:start -->
<!-- ======================================================== -->
<!-- D E L E G A T O R S -->
<!-- ======================================================== -->
-
+
<target name="maven:site">
<ant antfile="${maven.home}/build-docs.xml" target="site"/>
</target>
-
+
<target name="maven:jar">
<ant antfile="${maven.home}/build-maven.xml" target="jar"/>
</target>
-
+
<target name="maven:install-jar">
<ant antfile="${maven.home}/build-maven.xml" target="install-jar"/>
</target>
-
+
<target name="maven:env">
<ant antfile="${maven.home}/build-maven.xml" target="env"/>
</target>
-
+
<target name="maven:docs">
<ant antfile="${maven.home}/build-docs.xml" target="docs"/>
</target>
-
+
<target name="maven:test">
<ant antfile="${maven.home}/build-test.xml" target="test"/>
</target>
@@ -81,45 +80,44 @@
<target name="maven:singletest">
<ant antfile="${maven.home}/build-test.xml" target="run-singletest"/>
</target>
-
+
<target name="maven:clean">
<ant antfile="${maven.home}/build-maven.xml" target="clean"/>
</target>
-
+
<target name="maven:metrics">
<ant antfile="${maven.home}/build-metrics.xml" target="metrics"/>
</target>
-
+
<target name="maven:dist">
<ant antfile="${maven.home}/build-maven.xml" target="dist"/>
</target>
-
+
<target name="maven:deploy-site">
<ant antfile="${maven.home}/build-docs.xml" target="deploy-site"/>
</target>
-
+
<target name="maven:deploy-dist">
<ant antfile="${maven.home}/build-maven.xml" target="deploy-dist"/>
</target>
-
+
<target name="maven:gump-descriptor">
<ant antfile="${maven.home}/build-maven.xml" target="gump-descriptor"/>
</target>
-
+
<target name="maven:javadocs">
<ant antfile="${maven.home}/build-docs.xml" target="javadocs"/>
</target>
-
+
<target name="maven:compile">
<ant antfile="${maven.home}/build-maven.xml" target="compile"/>
</target>
-
+
<target name="maven:update-jars">
<ant antfile="${maven.home}/build-maven.xml" target="update-jars"/>
</target>
-
-<!-- maven:end -->
- ]]></source>
+
+<!-- maven:end -->]]></source>
<p>
It is important to note the use of the <code>maven:start</code>
and <code>maven:end</code> delimiters. This will enable Maven
@@ -179,7 +177,7 @@
<td>No</td>
<td>
Specifies the directory on the file system that downloaded
- jars are stored. Used by the
+ jars are stored. Used by the
<a href="#maven:update-jars">maven:update-jars</a> target.
</td>
</tr>
@@ -205,7 +203,7 @@
<td>Yes</td>
<td>
Specifies the port of the proxy server to use when
- downloading jars. Used by the
+ downloading jars. Used by the
<a href="#maven:update-jars">maven:update-jars</a> target.
</td>
</tr>
@@ -213,7 +211,7 @@
<td>build.includes.aspects</td>
<td>Yes</td>
<td>
- Specifies that Aspects are included during compilation. Used by the
+ Specifies that Aspects are included during compilation. Used by the
<a href="#maven:compile">maven:compile</a> target.
</td>
</tr>
@@ -277,7 +275,7 @@
<p>
The <code>maven:update-jars</code> target uses HTTP to download the jar files
required to build the project. The dependencies of
- a project are determined from the
+ a project are determined from the
<a href="project-descriptor.html#dependencies"><code>dependencies</code></a>
element of the Maven project descriptor.
</p>
@@ -301,7 +299,7 @@
<p>
The <code>maven:compile</code> target compiles all of the source
files that are part of the project. The list of source files,
- more specifically the directories, is determined from the
+ more specifically the directories, is determined from the
<a href="project-descriptor.html#sourceDirectories"><code>sourceDirectories</code></a>
element of the Maven project descriptor.
</p>
@@ -319,7 +317,7 @@
property is set, the AspectJ compiler will be used to compile
the source [TODO: add a link to a page that describes how to
setup one's AspectJ environment]. The aspect source files are
- determined from the
+ determined from the
<a href="project-descriptor.html#aspectSourceDirectories"><code>aspectSourceDirectories</code></a>
element of the Maven project descriptor.
</p>
@@ -330,14 +328,14 @@
This is the default target of the build file. The contents of
the jar file include the compiled classes located in
<code>target/classes</code> and any other additional jar
- resources specified by the
+ resources specified by the
<a href="project-descriptor.html#jarResources"><code>jarResources</code></a>
element of the Maven project descriptor. These additional
resources might include images, configuration files, or DTDs.
</p>
<p>
The generated jar file is placed in the <code>target</code>
- directory relative to the base directory of the project. The
+ directory relative to the base directory of the project. The
<a href="project-descriptor.html#project"><code>project</code></a>
element of the Maven project descriptor is used when creating
the name of the jar file. The current naming convention is
@@ -357,7 +355,7 @@
</p>
<p>
The generated packages are placed in the <code>target</code>
- directory relative to the base directory of the project. The
+ directory relative to the base directory of the project. The
<a href="project-descriptor.html#project"><code>project</code></a>
element of the Maven project descriptor is used when creating
the name of the distributions. The current naming convention is
@@ -380,7 +378,7 @@
<p>
The <code>maven:install-jar</code> target installs the project's jar
file into the <code>${lib.repo}</code> directory. If the jar
- file has not been created, it is first built.
+ file has not been created, it is first built.
</p>
</subsection>
<subsection name="maven:gump-descriptor">
@@ -397,7 +395,7 @@
<subsection name="maven:clean">
<p>
The <code>maven:clean</code> target deletes the build directory
- which is currently the <code>target</code> directory.
+ which is currently the <code>target</code> directory.
</p>
</subsection>
</section>
@@ -440,7 +438,7 @@
page for the project with links to the list of developers,
mailing-lists, dependencies, source metrics, and other project
specified documentation in xdoc format. The documentation for
- the project is determined from various elements of the
+ the project is determined from various elements of the
<a href="project-descriptor.html#project"><code>project</code></a>
element of the Maven project descriptor. In addition, any
documentation in the <code>xdoc</code> directory is
@@ -548,9 +546,9 @@
The <code>maven:test</code> target executes all of the unit tests
(JUnit) and run-time tests of the project. First, the source
for all of the tests is compiled. The location of the test
- source code is determined from the
+ source code is determined from the
<a href="project-descriptor.html#testSourceDirectories"><code>testSourceDirectories</code></a>
- element of the Maven project descriptor. In addition, the
+ element of the Maven project descriptor. In addition, the
<a href="project-descriptor.html#unitTestClassEntries"><code>unitTestClassEntries</code></a>
and
<a href="project-descriptor.html#runtimeTestClassEntries"><code>runtimeTestClassEntries</code></a>
@@ -569,7 +567,7 @@
The <code>maven:run-singletest</code> target executes a single unit test
(JUnit) of the project. First, the source
for all of the tests is compiled. The location of the test
- source code is determined from the
+ source code is determined from the
<a href="project-descriptor.html#testSourceDirectories"><code>testSourceDirectories</code></a>
element of the Maven project descriptor. The specific unit
test to invoke must be specified via the <code>testcase</code>
1.8 +25 -45 jakarta-turbine-maven/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/getting-started.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- getting-started.xml 21 Mar 2002 04:09:48 -0000 1.7
+++ getting-started.xml 26 Mar 2002 01:04:29 -0000 1.8
@@ -54,29 +54,25 @@
<code>${user.home}/build.properties</code> file. You'll need to
determine the location you want your Maven installation to
reside, as well as the location of your JAR repository. If you
- don't have a <code>${user.home}/build.properties</code>,
+ don't have a <code>${user.home}/build.properties</code>,
create a file that contains the following two lines with
appropriate values for your environment:
</p>
- <source><![CDATA[
- lib.repo = /home/kaz/src/lib.repo
- maven.home = /home/kaz/maven
- ]]></source>
+ <source><![CDATA[lib.repo = /home/kaz/src/lib.repo
+maven.home = /home/kaz/maven]]></source>
<p>
Download the <code>maven-install.jar</code> file to your local
filesystem. This JAR contains everything required to install
Maven on your system. The installation process consists of two
steps: the installation of Maven specific files, and the
- installation of the required JARs that Maven utilizes.
+ installation of the required JARs that Maven utilizes.
Lets start by installing Maven specific files in your
filesystem. Simply, unjar the JAR file in the directory you
want your Maven installation to reside. Note: the JAR has been
packaged with a top-level <code>maven</code> directory for
convenience.
</p>
- <source><![CDATA[
- jar xf maven-install.jar
- ]]></source>
+ <source><![CDATA[jar xf maven-install.jar]]></source>
<p>
Verify that your <code>${maven.home}</code> property points to
the correct location. In the top-level directory of
@@ -87,10 +83,8 @@
<code>${maven.home}/install</code> directory. To install these
files, type the following:
</p>
- <source><![CDATA[
- cd ${maven.home}/install
- ant
- ]]></source>
+ <source><![CDATA[cd ${maven.home}/install
+ant]]></source>
<p>
Verify the your <code>${lib.repo}</code> directory contains
several JAR files, including the most important one:
@@ -118,7 +112,7 @@
definition. The easiest way to do this is to create an XML
representation of this definition. In Maven-terms, this is
called the <a href="project-descriptor.html">project
- descriptor</a>.
+ descriptor</a>.
</p>
<p>
You'll need to create a project descriptor to use Maven with
@@ -163,8 +157,7 @@
<code>build.xml</code>). For example, here is the beginning
of the Fulcrum's <code>build-maven.xml</code> file:
</p>
- <source><![CDATA[
-<?xml version="1.0"?>
+ <source><![CDATA[<?xml version="1.0"?>
<project name="maven" default="maven:jar" basedir=".">
@@ -179,23 +172,23 @@
<property file="project.properties" />
<!-- maven:start -->
-
+
<!-- ========================================================== -->
<!-- D E L E G A T O R S -->
<!-- ========================================================== -->
-
- <target
+
+ <target
name="maven:site">
<ant antfile="${maven.home}/build-docs.xml" target="site"/>
</target>
-
- <target
+
+ <target
name="maven:jar"
depends="om">
<ant antfile="${maven.home}/build-maven.xml" target="jar"/>
</target>
-
- <target
+
+ <target
name="maven:compile"
depends="om">
<ant antfile="${maven.home}/build-maven.xml" target="compile"/>
@@ -206,8 +199,7 @@
.
<!-- maven:end -->
-</project>
- ]]></source>
+</project>]]></source>
</subsection>
<subsection name="Custom Properties">
@@ -225,9 +217,8 @@
<code>${maven.home}/default.properties</code> file (shown
below):
</p>
- <source><![CDATA[
- # ------------------------------------------------------------
- # D E F A U L T M A V E N P R O P E R T I E S
+<source><![CDATA[# ------------------------------------------------------------
+# D E F A U L T M A V E N P R O P E R T I E S
# ------------------------------------------------------------
# These are the properties that we believe are immutable so we
# keep them apart from the project specific properties.
@@ -254,8 +245,7 @@
javadoc.author = true
javadoc.private = true
javadoc.version = true
-javadoc.use = true
- ]]></source>
+javadoc.use = true]]></source>
<p>
If you wish to override these properties, you can do so by
creating your own properties file in your project's directory
@@ -295,9 +285,7 @@
download/update all of the required dependencies. Maven makes
this easy, type the following:
</p>
- <source><![CDATA[
- ant -f build-maven.xml maven:update-jars
- ]]></source>
+ <source><![CDATA[ant -f build-maven.xml maven:update-jars]]></source>
<p>
As you can tell by the above command, the current Turbine
projects have their Maven delegators in a separate build file to
@@ -319,9 +307,7 @@
dependent JARs, generating a JAR for a Mavenized Turbine project
is easy. Type the following:
</p>
- <source><![CDATA[
- ant -f build-maven.xml maven:jar
- ]]></source>
+ <source><![CDATA[ant -f build-maven.xml maven:jar]]></source>
<p>
You'll notice that all of the code is compiled, and then unit
tested, before it is packaged into a JAR file. The unit tests
@@ -341,9 +327,7 @@
href="/site/jakarta-site2.html"> xdocs</a>. To generate all of
the documentation mentioned above, type the following:
</p>
- <source><![CDATA[
- ant -f build-maven.xml maven:site
- ]]></source>
+ <source><![CDATA[ant -f build-maven.xml maven:site]]></source>
<p>
The result of this command is a <code>docs</code> directory in
the project's base directory that contains an entire web site of
@@ -351,9 +335,7 @@
and you want to publish this site to the web server, type the
following:
</p>
- <source><![CDATA[
- ant -f build-maven.xml maven:deploy-site
- ]]></source>
+ <source><![CDATA[ant -f build-maven.xml maven:deploy-site]]></source>
<p>
Assuming you have access to the web server, your entire site
would have been published. This makes updating the project's web
@@ -362,9 +344,7 @@
directory because you are so excited about Maven that you want to
try everything again! Type the following:
</p>
- <source><![CDATA[
- ant -f build-maven.xml maven:clean
- ]]></source>
+ <source><![CDATA[ant -f build-maven.xml maven:clean]]></source>
<p>
For a full description of all of the Maven targets available,
please refer to the <a href="build-file.html">build file</a>
1.8 +3 -7 jakarta-turbine-maven/xdocs/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/project-descriptor.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- project-descriptor.xml 20 Mar 2002 22:52:52 -0000 1.7
+++ project-descriptor.xml 26 Mar 2002 01:04:29 -0000 1.8
@@ -28,9 +28,7 @@
The following is the DTD that specifies the elements and
attributes of the Maven project descriptor.
</p>
- <source><![CDATA[
- [TODO: Insert DTD here]
- ]]></source>
+ <source><![CDATA[[TODO: Insert DTD here]]]></source>
</section>
<section name="Sample Project Descriptor">
<p>
@@ -39,8 +37,7 @@
by Maven (we believe in eating our own food :) Detailed
information on the elements are provided later in this document.
</p>
- <source><![CDATA[
-<?xml version="1.0"?>
+ <source><![CDATA[<?xml version="1.0"?>
<project>
<name>jakarta-turbine-maven</name>
@@ -285,8 +282,7 @@
<jars>
</jars>
</build>
-</project>
- ]]></source>
+</project>]]></source>
</section>
<section name="project">
<p>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>