I've attached two patches that update the description of the Torque
build process in README.html and xdocs/developer-guide.html, because the
tutorial I just finished references these updated sections. I removed
the descriptions of which libraries are needed and what they are used
for since the list has grown so much. However, at least now the build
process is documented correctly. If anyone has strong feelings about
the list of libraries, I can add them back.
Thanks,
Pete
--
Peter Kazmier http://www.kazmier.com
PGP Fingerprint 4FE7 8DA3 D0B5 9CAA 69DC 7243 1855 BC2E 4B43 5654
Index: README.txt
===================================================================
RCS file: /home/cvspublic/jakarta-turbine-torque/README.txt,v
retrieving revision 1.3
diff -u -r1.3 README.txt
--- README.txt 28 Nov 2001 17:05:32 -0000 1.3
+++ README.txt 10 Feb 2002 07:56:28 -0000
@@ -15,25 +15,40 @@
--------------------------------------------------------------------------
You must have ant version 1.4 or newer installed.
-You must set the following properties in either your
-${user.home}/build.properties file, or a build.properties file added
-by you to the Torque top-level directory:
-
-velocity.jar
-xerces.jar
-village.jar
-log4j.jar
-
-Alternately, you can set the property lib.repo to the directory acting
-as a repository holding the JARs named by default.properties.
-
-Torque uses Velocity to generate the OM sources, and Torque
-XML schema parsing requires Xerces. We will soon move to using
-the Digester to parse the XML schema, and at that point any
-SAX parser will be sufficient.
-
-Village is required to build the distribution. Village isn't
-needed for building, but the generated classes are dependent
-on Village.
+Building the decoupled version of Torque from CVS is now very
+easy. Recently, changes have been made to the Torque build
+process to simplify the acquisition of jar dependencies. The
+entire build process is now a four-step process.
-Log4j is required for logging in Torque.
+The first step of the process is to obtain the source. Checkout
+the jakarta-turbine-torque repository. If you are unfamiliar
+with the Jakarta CVS repositories, please refer to the CVS
+Repositories document for assistance at:
+http://jakarta.apache.org/site/cvsindex.html.
+
+Next, you must define the lib.repo property in your
+${user.home}/build.properties file. If you do not have a
+${user.home}/build.properties file, create one in your home
+directory and add the following line:
+
+ lib.repo = /path/to/some/directory
+
+The value of this property determines the location that the
+Torque dependencies will be stored after they have been
+downloaded. Note: this directory must exist in the filesystem.
+
+Next, in the top-level directory of the Torque distribution, type
+the following command to download all of the dependencies
+required to build Torque:
+
+ ant update-jars
+
+Lastly, after all of the jars have been downloaded to your
+lib.repo directory, building the Torque distribution is only a
+matter of typing the following command:
+
+ ant dist
+
+The resulting jar file and zip distribution will be located in
+the bin directory. For those interested in building applications
+with Torque, only the zip distribution is needed.
Index: xdocs/developer-guide.xml
===================================================================
RCS file: /home/cvspublic/jakarta-turbine-torque/xdocs/developer-guide.xml,v
retrieving revision 1.4
diff -u -r1.4 developer-guide.xml
--- xdocs/developer-guide.xml 10 Nov 2001 18:47:32 -0000 1.4
+++ xdocs/developer-guide.xml 10 Feb 2002 07:51:07 -0000
@@ -37,44 +37,60 @@
<section name="Building">
- <p>
- You must set the following properties in either your <code>
- ${user.home}/build.properties</code> file, or a <code>build.properties
- </code> file added by you to the Torque top-level directory:
- </p>
- <source><![CDATA[
- velocity.jar
- logkit.jar
- xerces.jar
- village.jar
- log4j.jar
- ]]></source>
-
- <p>
- Alternately, you can set the property <code>lib.repo</code> to the
- directory acting as a repository holding the JARs named by
- <code>default.properties</code>.
- </p>
-
- <p>
- Torque uses <a href="http://jakarta.apache.org/velocity";>Velocity</a> to
- generate the OM sources, and Torque XML schema parsing requires
- <a href="http://xml.apache.org/xerces-j";>Xerces</a>. We will soon move
- to using the Digester to parse the XML schema, and at that point any SAX
- parser will be sufficient.
- </p>
-
- <p>
- <a href="http://share.whichever.com/index.php?SCREEN=village";>Village
- </a> is required to build the distribution. Village isn't needed for
- building, but the generated classes are dependent on Village.
- </p>
-
- <p>
- <a href="http://jakarta.apache.org/log4j";>Log4j</a> is required for
- logging in Torque.
- </p>
-
+ <p>
+ Building the decoupled version of Torque from CVS is now
+ very easy. Recently, changes have been made to the Torque
+ build process to simplify the acquisition of jar
+ dependencies. The entire build process is now a four-step
+ process.
+ </p>
+ <p>
+ The first step of the process is to obtain the source.
+ Checkout the <code>jakarta-turbine-torque</code>
+ repository. If you are unfamiliar with the Jakarta CVS
+ repositories, please refer to the
+ <a href="/site/cvsindex.html">CVS Repositories</a> document
+ for assistance.
+ </p>
+ <p>
+ Next, you must define the <code>lib.repo</code> property in
+ your <code>${user.home}/build.properties</code> file. If
+ you do not have a <code>${user.home}/build.properties</code>
+ file, create one in your home directory and add the
+ following line:
+ </p>
+ <source><![CDATA[
+ lib.repo = /path/to/some/directory
+ ]]></source>
+ <p>
+ The value of this property determines the location that the
+ Torque dependencies will be stored after they have been
+ downloaded. Note: this directory must exist in the
+ filesystem.
+ </p>
+ <p>
+ Next, in the top-level directory of the Torque distribution,
+ type the following command to download all of the
+ dependencies required to build Torque:
+ </p>
+ <source><![CDATA[
+ ant update-jars
+ ]]></source>
+ <p>
+ Lastly, after all of the jars have been downloaded to your
+ <code>lib.repo</code> directory, building the Torque
+ distribution is only a matter of typing the following
+ command:
+ </p>
+ <source><![CDATA[
+ ant dist
+ ]]></source>
+ <p>
+ The resulting jar file and zip distribution will be located
+ in the <code>bin</code> directory. For those interested in
+ building applications with Torque, only the zip distribution
+ is needed.
+ </p>
</section>
<section name="Testing">
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
