craigmcc 01/03/23 16:05:37
Modified: . README
doc installation.xml
Log:
Update the README and installation information to reflect the use of "ant"
directly, rather than the build.sh and build.bat scripts, to run Struts
builds.
Eventually, the build.sh and build.bat scripts will be removed, once we've
gained some experience with the new approach and made sure there are no
gotchas.
Revision Changes Path
1.13 +2 -2 jakarta-struts/README
Index: README
===================================================================
RCS file: /home/cvs/jakarta-struts/README,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- README 2001/02/06 20:31:07 1.12
+++ README 2001/03/24 00:05:36 1.13
@@ -1,4 +1,4 @@
-$Id: README,v 1.12 2001/02/06 20:31:07 craigmcc Exp $
+$Id: README,v 1.13 2001/03/24 00:05:36 craigmcc Exp $
Struts
======
@@ -164,7 +164,7 @@
download and install a source distribution of Struts from
<http://jakarta.apache.org/builds/jakarta-struts/nightly/src>. You will also
need a recent nightly build of the Ant project development tool (you *must*
-use version 1.2 or later of Ant).
+use version 1.3 or later of Ant).
Before committing any changes to the Struts CVS repository, you must do a
"build clean" followed by a "build dist", to ensure that everything compiles
1.2 +56 -26 jakarta-struts/doc/installation.xml
Index: installation.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- installation.xml 2001/03/18 17:48:58 1.1
+++ installation.xml 2001/03/24 00:05:36 1.2
@@ -29,14 +29,17 @@
<a href="http://jakarta.apache.org/tomcat">Tomcat</a> (version 3.1
or later required, version 3.2 or later recommended).</li>
<li><strong>Ant Build System</strong> - If you are building Struts from the
- source distribution, you must download and install version 1.2 or later
+ source distribution, you must download and install version 1.3 or later
of the <a href="http://jakarta.apache.org/ant">Ant</a> build system.
This package is also strongly recommended for use in developing your
own web applications based on Struts.
<ul>
- <li>If you are using the release version of Ant version 1.2, you will
+ <li>If you are using the release version of Ant version 1.3, you will
also need to download the "optional.jar" file that contains the
implementation of Ant's <code><style></code> command.</li>
+ <li>Make sure that the "ant" and "ant.bat" scripts are executable, by
+ adding the $ANT_HOME/bin directory to your PATH environment
+ variable.</li>
</ul></li>
<li><strong>Servlet API Classes</strong> - In order to compile Struts itself,
or applications that use Struts, you will need a <code>servlet.jar</code>
@@ -81,27 +84,44 @@
<a href="#Prerequisites">prerequisite</a> software packages described
above.</p>
- <p>To build Struts, you will need to customize your development
- environment as follows:</p>
+ <p>To build Struts, you will need to customize the build process to the
+ details of your development environment as follows:</p>
<ul>
- <li>Set an environment variable <code>ANT_HOME</code> that contains the
- absolute pathname of the directory where you installed Ant.</li>
- <li>Set an environment variable <code>JAVA_HOME</code> that contains the
- absolute pathname of the directory where you installed your
- Java Development Kit.</li>
- <li>Set an environment variable <code>SERVLETAPI_HOME</code> that contains
- the absolute pathname of the directory where you installed the Servlet
- API distribution (not required if you have <code>servlet.jar</code>
- on your CLASSPATH already).</li>
+ <li>The Struts source distribution uses a file named
+ <code>build.properties</code> (in the top-level directory of the
+ distribution) to identify the location of external components
+ that Struts depends on.</li>
+ <li>There is no <code>build.properties</code> file included with the
+ source distribution. However, there is an example file named
+ <code>build.properties.example</code> that you can copy to
+ <code>build.properties</code> and then customize.</li>
+ <li>The properties you must configure in <code>build.properties</code> are:
+ <ul>
+ <li><strong>catalina.home</strong> - Pathname to the directory of your
+ binary distribution of Tomcat 4.0 (required only if you wish to
+ use the <code>deploy.catalina</code> target).</li>
+ <li><strong>servletapi.home</strong> - Pathname to the directory of
+ your binary distribution of the Servlet API classes.</li>
+ <li><strong>tomcat.home</strong> - Pathname to the directory of your
+ binary distribution of Tomcat 3.2 (required only if you wish to
+ use the <code>deploy.tomcat</code> target).</li>
+ <li><strong>xerces.home</strong> - Pathname to the directory of your
+ binary distribution of the Xerces parser, version 1.2 or 1.3
+ (required only if you wish to use the <code>deploy.catalina</code>
+ target).</li>
+ </ul></li>
+ <li>If you are a Struts developer with write access to the CVS repository,
+ be sure that you do <strong>NOT</strong> check in a copy of the
+ <code>build.properties</code> file, since it will be different for
+ each individual developer.</li>
</ul>
<p>To build a "distribution" version of Struts, first change your current
directory to the directory in which you have unpacked the Struts
- source distribution, and then type one of the following commands (based
- on whether you are running on a Unix or Windows platform):</p>
-
-<pre>./build.sh dist <-- Unix platform
-build dist <-- Windows platform
+ source distribution, and (if necessary) create or customize the
+ <code>build.properties</code> file as described above. Then, type:</p>
+<pre>
+ ant dist
</pre>
<p>This command will create a binary distribution of Struts, in a
@@ -128,11 +148,20 @@
<ul>
<li><strong>lib/struts.jar</strong> - This JAR file contains all of the
Java classes included in Struts. It should be copied into the
- <code>WEB-INF/lib</code> directory of your web application.</li>
+ <code>WEB-INF/lib</code> directory of your web application.
+ <em>WARNING</em> - If you are going to be hosting multiple Struts
+ based applications on the same servlet container, you will be tempted
+ to place the <code>struts.jar</code> file into the shared repository
+ supported by your container. Be advised that this will like cause you
+ to encounter ClassNotFoundException problems unless <em>all</em> of
+ your application classes are stored in the shared repository.</li>
<li><strong>lib/struts*.tld</strong> - These are the "tag library
descriptor" files that describe the custom tags in the various Struts
tag libraries. They should be copied into the <code>WEB-INF</code>
directory of your web application.</li>
+ <li><strong>webapps/struts-blank.war</strong> - This is a simple "web
+ application archive" file containing a basic starting point for
+ building your own Struts-based applications.</li>
<li><strong>webapps/struts-documentation.war</strong> - This is a
"web application archive" file containing all of the Struts
documentation found on the
@@ -143,21 +172,22 @@
web application that uses a large percentage of Struts features.
You can install this web application on any servlet container
compatible with the Servlet 2.2 (or later) and JSP 1.1 (or later)
- specifications.</li>
+ specifications. If an XML parser is not made available to web
+ applications by your container, you will need to add one to the
+ WEB-INF/lib directory of this web application.</li>
+ <li><strong>webapps/struts-exercise-taglib.war</strong> - This web
+ application contains test pages for the various custom tags supported
+ by Struts. It is primarily of use to developers who are enhancing the
+ Struts custom tag libraries, but may also be useful as simple examples
+ of the usage of various Struts tags.</li>
<li><strong>webapps/struts-template.war</strong> - This web application
both introduces and demonstrates the Struts template tags.</li>
- <li><strong>webapps/struts-test.war</strong> - This web application
- contains test pages for the various custom tags supported by Struts.
- It is primarily of use to developers who are enhancing the Struts
- custom tag libraries, but may also be useful as simple examples of
- the usage of various Struts tags.</li>
<li><strong>webapps/struts-upload.war</strong> - This web application
is a quick example of uploading files using the Struts framework.</li>
</ul>
<p>To use Struts in your own application, you will need to follow
these steps:</p>
-
<ul>
<li>Copy the file <code>lib/struts.jar</code> from the Struts distribution
into the <code>WEB-INF/lib</code> directory of your web application.
