Author: brett
Date: Thu Mar 3 07:31:03 2005
New Revision: 156054
URL: http://svn.apache.org/viewcvs?view=rev&rev=156054
Log:
adapting document
Modified:
maven/maven-1/core/trunk/xdocs/index.xml
maven/maven-1/core/trunk/xdocs/start/adapting.xml
Modified: maven/maven-1/core/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/index.xml?view=diff&r1=156053&r2=156054
==============================================================================
--- maven/maven-1/core/trunk/xdocs/index.xml (original)
+++ maven/maven-1/core/trunk/xdocs/index.xml Thu Mar 3 07:31:03 2005
@@ -47,8 +47,8 @@
</p>
<p><b>Want to adapt an existing project to use Maven?</b></p>
<p>
- Read our <a href="start/adapting.html">Adapting a Project</a> guide
for a step-by-step procedure
- to introduce Maven, and then replace pieces of the existing build.
+ Read our <a href="start/adapting.html">Adapting a Project</a> guide
for a guide on how to introduce Maven
+ to an existing build.
</p>
<p><b>Familiar with Ant, and want to see how Maven relates to
it?</b></p>
<p>
Modified: maven/maven-1/core/trunk/xdocs/start/adapting.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/start/adapting.xml?view=diff&r1=156053&r2=156054
==============================================================================
--- maven/maven-1/core/trunk/xdocs/start/adapting.xml (original)
+++ maven/maven-1/core/trunk/xdocs/start/adapting.xml Thu Mar 3 07:31:03 2005
@@ -28,290 +28,44 @@
<body>
<section name="Adapting an Existing Project to Use Maven">
-<!-- TODO:
- <section name="Integrating Maven with a Project">
<p>
- Now that you have Maven installed on your system, this section
- will show you how to integrate it with an existing project.
- There are plenty of <a href="../about/powered.html">Maven powered
- projects</a> that can
- be used as references.
- There is really only one step to integrating
- Maven with a project: the creation of the project descriptor.
- You may also create an ancillary <code>maven.xml</code> file which
- contains project specific goals, preGoals, and postGoals.
+ This guide will discuss introducing Maven to an existing project which
may have some other build system or none
+ at all. It is assumed that you are now a little familiar with Maven,
and have given it the
+ <a href="ten-minute-test.html">Ten Minute Test</a>, so have already
created a simple project.
+ </p>
+ <p>
+ There is really only one step to introducing Maven into a project: the
creation of the project descriptor.
+ Since this does not affect your other build files and should be able
to match your current layout,
+ the process is the same as for starting a new project, however more of
the values will be customised.
+ </p>
+ <p>
+ This approach can allow you to start getting some of the benefits of
Maven without disturbing something that
+ is already working.
+ </p>
+ <p>
+ However, eventually this will mean maintaining information in two
locations, which is not ideal. Hopefully you
+ will see that Maven offers the functionality of your existing build
environment without much additional work
+ and so will migrate towards using that as the sole platform.
+ </p>
+ <p>
+ For Ant users, there is a document called <a
href="../using/migrating-from-ant.html">Migrating from Ant</a>
+ that will be of assistance.
+ </p>
+ <p>
+ No matter what you are using, the principles are similar: move small
portions of your build to Maven, and make
+ Maven the central entry point for goals. For functionality remainining
in the existing environment, Maven can
+ call out to it to perform those tasks, using
<code><ant:ant/></code> or <code><ant:exec/></code>.
+ </p>
+ <p>
+ While Maven can usually be configured to match your environment, it is
also important to consider refactoring
+ your build, in the same way you would for your code. Changes small,
known pieces at a time towards a layout
+ that is encouraged by Maven's <a
href="../reference/conventions.html">Conventions Reference</a>.
+ </p>
+ <p>
+ If you need real-world examples, there are plenty of <a
href="../about/powered.html">Maven powered
+ projects</a> that can be used as references. However, it is worth
checking more than one and referring to the
+ <a href="../using/bestpractices.html">Best Practices</a> document as
you do this.
</p>
- <subsection name="Creating a Project Descriptor">
- <p>
- Everything in Maven gravitates around the definition of a
- project. The unit of work in Maven is the project, so before
- you can get started with Maven you need to create your project
- definition. The easiest way to do this is to create an XML
- representation of this definition. In Maven-terms, this is
- called the project descriptor.
- </p>
- <p>
- You'll need to create a project descriptor to use Maven with
- your project. The project descriptor must be called
- <code>project.xml</code> and must reside in the top-level
- directory of your project's directory hierarchy. The contents
- of the descriptor are described in detail in the <a
- href="../reference/project-descriptor.html">Project Descriptor</a>
- document. A sample project descriptor is included below for
- reference. In addition, all of the Turbine projects have
- valid project descriptors that you can examine.
- </p>
- <p>
- We are working on a tool that will help you create your
- project descriptor automatically, but if you want to get
- started right away with Maven, then you'll have to create your
- own <code>project.xml</code> file manually (probably easiest
- to just modify an existing one such as the one below). The
- following is the project descriptor used to describe the Maven
- project:
- </p>
- <source><![CDATA[<?xml version="1.0"?>
-<project>
- <pomVersion>3</pomVersion>
- <id>maven</id>
- <name>Maven</name>
- <currentVersion>1.0.1-SNAPSHOT</currentVersion>
- <organization>
- <name>Apache Software Foundation</name>
- <url>http://www.apache.org/</url>
- <logo>/images/apache-maven-project.png</logo>
- </organization>
- <inceptionYear>2001</inceptionYear>
- <package>org.apache.maven</package>
- <logo>/images/maven.gif</logo>
-
- <gumpRepositoryId>maven</gumpRepositoryId>
-
- <description>
- Maven is a project management and project comprehension
- tool. Maven is based on the concept of a project object
- model: builds, documentation creation, site publication,
- and distribution publication are all controlled from the
- project object model. Maven also provides tools to
- create source metrics, change logs based directly on
- source repository, and source cross-references.
- </description>
-
- <shortDescription>Java Project Management Tools</shortDescription>
-
- <url>http://maven.apache.org/</url>
- <issueTrackingUrl>
- http://jira.codehaus.org/BrowseProject.jspa?id=10030
- </issueTrackingUrl>
- <siteAddress>maven.apache.org</siteAddress>
- <siteDirectory>
- /www/maven.apache.org/
- </siteDirectory>
- <distributionSite>
- maven.apache.org
- </distributionSite>
- <distributionDirectory>
- /www/www.apache.org/dist/java-repository/
- </distributionDirectory>
-
- <repository>
- <connection>
- scm:cvs:pserver:[EMAIL PROTECTED]:/home/cvspublic:maven
- </connection>
- <developerConnection>
- scm:cvs:ext:[EMAIL PROTECTED]:/home/cvs:maven
- </developerConnection>
- <url>
- http://cvs.apache.org/viewcvs.cgi/maven/
- </url>
- </repository>
-
- <versions>
- <version>
- <id>b3</id>
- <name>1.0-b3</name>
- <tag>MAVEN_1_0_B3</tag>
- </version>
- <version>
- <id>b4</id>
- <name>1.0-b4</name>
- <tag>MAVEN_1_0_B4</tag>
- </version>
- <version>
- <id>1.0</id>
- <name>1.0</name>
- <tag>MAVEN_1_0</tag>
- </version>
- </versions>
- <branches/>
- <mailingLists>
- <mailingList>
- <name>Maven User List</name>
- <subscribe>
- [EMAIL PROTECTED]
- </subscribe>
- <unsubscribe>
- [EMAIL PROTECTED]
- </unsubscribe>
- <archive>
- http://mail-archives.apache.org/eyebrowse/[EMAIL PROTECTED]
- </archive>
- </mailingList>
- <mailingList>
- <name>Maven Developer List</name>
- <subscribe>
- [EMAIL PROTECTED]
- </subscribe>
- <unsubscribe>
- [EMAIL PROTECTED]
- </unsubscribe>
- <archive>
- http://mail-archives.apache.org/eyebrowse/[EMAIL PROTECTED]
- </archive>
- </mailingList>
- </mailingLists>
-
- <developers>
-
- <developer>
- <name>Juancarlo Anez</name>
- <id>juanco</id>
- <email>[EMAIL PROTECTED]</email>
- <organization/>
- <roles>
- <role>Java Developer</role>
- </roles>
- </developer>
-
- <developer>
- <name>Stephane Bailliez</name>
- <id>sbailliez</id>
- <email>[EMAIL PROTECTED]</email>
- <organization/>
- <roles>
- <role>Java Developer</role>
- </roles>
- </developer>
-
- .
- .
- .
-
- <developer>
- <name>Glenn McAllister</name>
- <id>glennm</id>
- <email>[EMAIL PROTECTED]</email>
- <organization>SOMA Networks, Inc.</organization>
- <roles>
- <role>Java Developer</role>
- </roles>
- </developer>
-
- </developers>
-
- <licenses>
- <license>
- <name>The Apache Software License, Version 2.0</name>
- <url>http://cvs.apache.org/viewcvs.cgi/*checkout*/maven/LICENSE.txt</url>
- <distribution>repo</distribution>
- </license>
- </licenses>
-
- <dependencies>
-
- <dependency>
- <groupId>dom4j</groupId>
- <artifactId>dom4j</artifactId>
- <version>1.4-dev-8</version>
- <url>http://www.dom4j.org/</url>
- </dependency>
-
- <dependency>
- <groupId>ant</groupId>
- <artifactId>ant</artifactId>
- <version>1.5.3-1</version>
- <url>http://ant.apache.org/</url>
- </dependency>
-
- .
- .
- .
-
- <dependency>
- <groupId>maven</groupId>
- <artifactId>maven-jelly-tags</artifactId>
- <version>1.0</version>
- </dependency>
-
- </dependencies>
-
- <build>
-
- <nagEmailAddress>
- [email protected]
- </nagEmailAddress>
-
- <sourceDirectory>src/java</sourceDirectory>
-
- <unitTestSourceDirectory>src/test/java</unitTestSourceDirectory>
-
- <unitTest>
- <includes>
- <include>**/*Test.java</include>
- </includes>
- <excludes>
- <exclude>**/JAXPTest.java</exclude>
- </excludes>
- </unitTest>
-
- <resources>
- <resource>
- <directory>${basedir}</directory>
- <targetPath>META-INF</targetPath>
- <includes>
- <include>NOTICE.txt</include>
- </includes>
- </resource>
- <resource>
- <directory>src/conf</directory>
- <includes>
- <include>*.xsd</include>
- <include>*.dtd</include>
- <include>*.mod</include>
- <include>*.properties</include>
- <include>driver.jelly</include>
- <include>LICENCE.txt</include>
- </includes>
- </resource>
- <resource>
- <directory>src/messages</directory>
- <targetPath>org/apache/maven/messages</targetPath>
- <includes>
- <include>messages*.properties</include>
- </includes>
- </resource>
- </resources>
- </build>
-</project>]]></source>
- </subsection>
-
- <subsection name="Using Maven with your existing build">
- <p>
- Maven doesn't require the use of any Ant build files so you can
- try using Maven without affecting the way you traditionally
- build your project.
- </p>
- </subsection>
-
- <subsection name="Extending Maven's build system">
- <p>
- There are two main ways you can extend Maven's build system:
- creating new plug-ins, and adding additional processing in a
- project specific <code>maven.xml</code> file.
- </p>
- </subsection>
- </section>
--->
<p>...</p>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
