Author: tfischer
Date: Sun Nov 5 03:13:28 2006
New Revision: 471399
URL: http://svn.apache.org/viewvc?view=rev&rev=471399
Log:
- Documented the maven 2 build process and usage of the Test project with Maven
2.
- Mentioned the checkstyle reports in the Codestyle document.
Modified:
db/torque/site/trunk/xdocs/changes.xml
db/torque/site/trunk/xdocs/developer-info/codestyle.xml
db/torque/site/trunk/xdocs/developer-info/developer-guide.xml
db/torque/site/trunk/xdocs/developer-info/subversion.xml
db/torque/site/trunk/xdocs/developer-info/test-project.xml
Modified: db/torque/site/trunk/xdocs/changes.xml
URL:
http://svn.apache.org/viewvc/db/torque/site/trunk/xdocs/changes.xml?view=diff&rev=471399&r1=471398&r2=471399
==============================================================================
--- db/torque/site/trunk/xdocs/changes.xml (original)
+++ db/torque/site/trunk/xdocs/changes.xml Sun Nov 5 03:13:28 2006
@@ -28,6 +28,9 @@
<body>
<release version="3.2.1-dev" date="in SVN">
+ <action type="add" dev="tfischer" issue="TORQUE-2" due-to="Raphael
Pieroni">
+ Added maven 2 plugin.
+ </action>
<action type="fix" dev="tfischer" issue="TORQUE-57">
Fixed handling of escaping (by backslashes) for LIKE clauses.
</action>
Modified: db/torque/site/trunk/xdocs/developer-info/codestyle.xml
URL:
http://svn.apache.org/viewvc/db/torque/site/trunk/xdocs/developer-info/codestyle.xml?view=diff&rev=471399&r1=471398&r2=471399
==============================================================================
--- db/torque/site/trunk/xdocs/developer-info/codestyle.xml (original)
+++ db/torque/site/trunk/xdocs/developer-info/codestyle.xml Sun Nov 5 03:13:28
2006
@@ -26,7 +26,8 @@
<p>
The Torque development team follows the
<a
href="http://jakarta.apache.org/turbine/common/code-standards.html";>Turbine
code style</a>.
- Please use this code style if you submit patches and extensions to
Torque.
+ Please use this code style if you submit patches and extensions
+ to Torque. The checkstyle reports are your friends.
</p>
</section>
</body>
Modified: db/torque/site/trunk/xdocs/developer-info/developer-guide.xml
URL:
http://svn.apache.org/viewvc/db/torque/site/trunk/xdocs/developer-info/developer-guide.xml?view=diff&rev=471399&r1=471398&r2=471399
==============================================================================
--- db/torque/site/trunk/xdocs/developer-info/developer-guide.xml (original)
+++ db/torque/site/trunk/xdocs/developer-info/developer-guide.xml Sun Nov 5
03:13:28 2006
@@ -32,7 +32,13 @@
<p>
The Torque build process uses
<a href="http://maven.apache.org/maven1";>Maven 1</a>. The recommended
- Maven version is Maven 1.0.2. Maven2 is not supported.
+ Maven version is Maven 1.0.2. A rudimentary
+ <a href="http://maven.apache.org";>Maven 2</a> build exists (see below),
+ but is only used to build the Maven 2 plugin.
+ <br/>
+ Note that the Maven 1 build uses the groupId <code>torque</code>,
+ wheras the Maven 2 build uses the group id
+ <code>org.apache.db.torque</code>code>.
</p>
<p>
Before you begin, you'll need to check out the <code>trunks</code>
@@ -40,29 +46,46 @@
Please read the <a href="subversion.html">Torque Subversion</a> page
for more information.
</p>
- <p>
- To build the Torque generator jar, first execute
- <code>maven jar:install</code> in the
- <code>templates</code> directory to install a copy
- of the templates jar in your local Maven repository. Note that
- <code>maven jar:jar</code> does not suffice because the
- main generator jar depends upon the template jar.
- Afterwards, execute <code>maven jar:jar</code> in the generator
- directory to build the generator jar (<code>maven jar:install</code>
- to install a copy of the jar in your local Maven repository).
- </p>
- <p>
- To build and install the Torque maven-plugin, execute <code>maven
- plugin:install</code> in the <code>maven-plugin</code> directory.
- You need to have the generator installed in your local repository
- to do that (see paragraph above).
- </p>
- <p>
- To build the Torque runtime jar execute <code>maven jar:jar</code> in
- the <code>runtime</code> directory
- (<code>maven jar:install</code> to install a copy of the jar
- in your local Maven repository).
- </p>
+
+ <subsection name="Maven 1 build">
+ <p>
+ To build the Torque generator jar, first execute
+ <code>maven jar:install</code> in the
+ <code>templates</code> directory to install a copy
+ of the templates jar in your local Maven repository. Note that
+ <code>maven jar:jar</code> does not suffice because the
+ main generator jar depends upon the template jar.
+ Afterwards, execute <code>maven jar:jar</code> in the generator
+ directory to build the generator jar (<code>maven jar:install</code>
+ to install a copy of the jar in your local Maven repository).
+ </p>
+ <p>
+ To build and install the Torque Maven 1 plugin, execute <code>maven
+ plugin:install</code> in the <code>maven-plugin</code> directory.
+ You need to have the generator installed in your local repository
+ to do that (see paragraph above).
+ </p>
+ <p>
+ To build the Torque runtime jar execute <code>maven jar:jar</code> in
+ the <code>runtime</code> directory
+ (<code>maven jar:install</code> to install a copy of the jar
+ in your local Maven repository).
+ </p>
+ <p>
+ The Torque Maven 2 plugin cannot be built using Maven 1.
+ </p>
+ </subsection>
+
+ <subsection name="Maven 2 build">
+ <p>
+ Change into the directories runtime, templates, generator, and
+ maven2-plugin in this order and run <code>mvn install</code>code>
+ in each of them.
+ </p>
+ <p>
+ The Torque Maven 1 plugin cannot be built using Maven 2.
+ </p>
+ </subsection>
</section>
<section name="Testing">
Modified: db/torque/site/trunk/xdocs/developer-info/subversion.xml
URL:
http://svn.apache.org/viewvc/db/torque/site/trunk/xdocs/developer-info/subversion.xml?view=diff&rev=471399&r1=471398&r2=471399
==============================================================================
--- db/torque/site/trunk/xdocs/developer-info/subversion.xml (original)
+++ db/torque/site/trunk/xdocs/developer-info/subversion.xml Sun Nov 5
03:13:28 2006
@@ -67,6 +67,7 @@
generator <--- contains the generator component
templates <--- contains the generator templates component
maven-plugin <--- contains the maven plugin component
+ maven2-plugin <--- contains the maven 2 plugin component
test <--- contains the test component
trunks <--- contains references to the trunks of all
component (via svn:externals)
@@ -85,18 +86,19 @@
<table>
<tr><th>Component</th><th>Trunk repository location</th></tr>
- <tr><td>Runtime</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/runtime/trunk/";>http://svn.apache.org/repos/asf/db/torque/runtime/trunk</a></td></tr>
- <tr><td>Generator</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/generator/trunk/";>http://svn.apache.org/repos/asf/db/torque/generator/trunk/</a></td></tr>
- <tr><td>Templates</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/templates/trunk/";>http://svn.apache.org/repos/asf/db/torque/templates/trunk/</a></td></tr>
- <tr><td>Maven-Plugin</td><td><a
href="http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/";>http://svn.apache.org/repos/asf/db/torque/maven-plugin/trunk/</a></td></tr>
- <tr><td>Site</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/site/trunk/";>http://svn.apache.org/repos/asf/db/torque/site/trunk/</a></td></tr>
- <tr><td>Common</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/common/trunk/";>http://svn.apache.org/repos/asf/db/torque/common/trunk/</a></td></tr>
- <tr><td>Test</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/test/trunk/";>http://svn.apache.org/repos/asf/db/torque/test/trunk/</a></td></tr>
+ <tr><td>Runtime</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/runtime/trunk/";>http://svn.apache.org/repos/asf/db/torque/runtime/trunk</a></td></tr>
+ <tr><td>Generator</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/generator/trunk/";>http://svn.apache.org/repos/asf/db/torque/generator/trunk/</a></td></tr>
+ <tr><td>Templates</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/templates/trunk/";>http://svn.apache.org/repos/asf/db/torque/templates/trunk/</a></td></tr>
+ <tr><td>Maven 1 Plugin</td><td><a
href="http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/";>http://svn.apache.org/repos/asf/db/torque/maven-plugin/trunk/</a></td></tr>
+ <tr><td>Maven 2 Plugin</td><td><a
href="http://svn.apache.org/viewcvs/db/torque/maven2-plugin/trunk/";>http://svn.apache.org/repos/asf/db/torque/maven2-plugin/trunk/</a></td></tr>
+ <tr><td>Site</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/site/trunk/";>http://svn.apache.org/repos/asf/db/torque/site/trunk/</a></td></tr>
+ <tr><td>Common</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/common/trunk/";>http://svn.apache.org/repos/asf/db/torque/common/trunk/</a></td></tr>
+ <tr><td>Test</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/test/trunk/";>http://svn.apache.org/repos/asf/db/torque/test/trunk/</a></td></tr>
</table>
</p>
</subsection>
- <subsection name="Runtime, Generator, Templates, Maven-Plugin">
+ <subsection name="Runtime, Generator, Templates, Maven 1 Plugin, Maven 2
Plugin">
<p>
These modules make up the main torque distribution. They
are released in regular intervals and are available as binary
Modified: db/torque/site/trunk/xdocs/developer-info/test-project.xml
URL:
http://svn.apache.org/viewvc/db/torque/site/trunk/xdocs/developer-info/test-project.xml?view=diff&rev=471399&r1=471398&r2=471399
==============================================================================
--- db/torque/site/trunk/xdocs/developer-info/test-project.xml (original)
+++ db/torque/site/trunk/xdocs/developer-info/test-project.xml Sun Nov 5
03:13:28 2006
@@ -52,7 +52,7 @@
</ul>
</p>
- <subsection name="Running the test project">
+ <subsection name="Running the test project using Maven 1">
<p>
In order to run the test project, the following procedure is
recommended:
@@ -89,7 +89,7 @@
</p>
</subsection>
- <subsection name="Common pitfalls">
+ <subsection name="Common pitfalls when using Maven 1">
<p>
If maven complains about not being able to load its parent POM,
this is probably due to one of the following:
@@ -111,6 +111,38 @@
</ul>
</p>
</subsection>
+
+ <subsection name="Running the test project using Maven 2">
+ <p>
+ In order to run the test project with maven 2, use the following
+ procedure:
+ <ul>
+ <li>
+ Check out the trunks module from the svn repository.
+ </li>
+ <li>
+ Change into the each of the directories <i>runtime</i>,
+ <i>templates</i>, <i>generator</i> and <i>maven2-plugin</i>
+ and run the command <code>mvn install</code>
+ in each of the directories (in the order above).
+ </li>
+ <li>
+ Change into the directory <i>trunks/test/test-project</i>,
+ and change one of the profiles in the file <i>profiles.xml</i>
+ to match the database which you want to test against.
+ </li>
+ <li>
+ In the directory <i>trunks/test/test-project</i>,
+ run the command <code>mvn -P${profile} package</code>
+ to run the test, replacing the variable
+ <code>${profile}</code> with the name of your chosen profile.
+ For example, if you want to test against mysql, run
+ <code>mvn -Pmysql package</code>
+ </li>
+ </ul>
+ </p>
+ </subsection>
+
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
