remm 2003/09/08 03:16:02
Modified: webapps/docs index.xml project.xml
Added: webapps/docs building.xml
Log:
- Move build docs from the website to the documentation.
Revision Changes Path
1.10 +4 -3 jakarta-tomcat-catalina/webapps/docs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/index.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- index.xml 24 Jul 2003 15:26:13 -0000 1.9
+++ index.xml 8 Sep 2003 10:16:02 -0000 1.10
@@ -125,9 +125,10 @@
<p>The following documents are for Java developers who wish to contribute to
the development of the <em>Tomcat</em> project.</p>
<ul>
-<li><a href="BUILDING.txt"><strong>Building from Source</strong></a> - Details the
- steps necessary to download Tomcat 5 source code (and the other packages
- that it depends on), and build a binary distribution from those sources.
+<li><a href="building.html"><strong>Building from Source</strong></a> -
+ Details the steps necessary to download Tomcat 5 source code (and the
+ other packages that it depends on), and build a binary distribution from
+ those sources.
</li>
<li><a href="changelog.html"><strong>Changelog</strong></a> - Details the
changes made to Tomcat.
1.15 +1 -1 jakarta-tomcat-catalina/webapps/docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/project.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- project.xml 14 Jul 2003 16:20:11 -0000 1.14
+++ project.xml 8 Sep 2003 10:16:02 -0000 1.15
@@ -49,7 +49,7 @@
</menu>
<menu name="Tomcat Development">
- <item name="Building from Source" href="BUILDING.txt"/>
+ <item name="Building" href="building.html"/>
<item name="Changelog" href="changelog.html"/>
<item name="Status" href="status.html"/>
<item name="Developers" href="developers.html"/>
1.1 jakarta-tomcat-catalina/webapps/docs/building.xml
Index: building.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document>
&project;
<properties>
<author>Remy Maucherat</author>
<title>Building Tomcat</title>
</properties>
<body>
<section name="Introduction">
<p>
Building Tomcat from CVS is very easy, and is the first step to contributing to
Tomcat. The following is a step by step TODO list.
</p>
</section>
<section name="Download and install a Java Development Kit 1.4.x or later">
<p>
Ealier releases would also work, but are harder to work with due to the need to
download additional dependencies. Tomcat also runs much faster on
the latest 1.4 JDK.
</p>
<p>
The Sun JDK can be downloaded <a href="http://java.sun.com/j2se/";>here</a>.
</p>
<p>
<b>IMPORTANT</b>: Set an environment variable JAVA_HOME to the pathname of the
directory into which you installed the JDK release.
</p>
</section>
<section name="Install Apache Ant 1.5.x">
<p>
Download a binary distribution of Ant 1.5.x from
<a href="http://ant.apache.org/bindownload.cgi";>here</a>.
</p>
<p>
Unpack the binary distribution into a convenient location so that the
Ant release resides in its own directory (conventionally named
"jakarta-ant-1.5.1"). For the purposes of the remainder of this document,
the symbolic name "${ant.home}" is used to refer to the full pathname of
the release directory.
</p>
<p>
Create an ANT_HOME environment variable to point the directory ${ant.home},
and modify the PATH environment variable to include directory
"${ant.home}/bin" in its list. This makes the "ant" command line script
available, which will be used to actually perform the build.
</p>
</section>
<section name="Building Tomcat">
<p>
Download the main build.xml script from <a href="build.xml">here</a>.
</p>
<p>
Create a new directory, and copy the newly download build.xml to it. This
directory will be referred to as the ${tomcat.source} directory in the rest
of this document.
</p>
<p>
Go to that directory, and do:
<code><br/>
cd ${tomcat.source}<br/>
ant<br/>
</code>
</p>
<p>
NOTE: Users accessing the Internet through a proxy must use a properties
file to indicate to Ant the proxy configuration. Read below.
</p>
<p>
WARNING: Running this command will checkout the Tomcat 5 sources from CVS, as
well as download binaries to the <code>/usr/share/java</code> directory.
Make sure this is appropriate to do so on your computer. On Windows,
this usually corresponds to the <code>C:\usr\share\java</code> directory,
unless Cygwin is used. Read below to customize the directory used
to download the binaries.
</p>
<p>
The build can be controlled by creating a ${tomcat.source}/build.properties
file, and adding the following content to it:
<code><br/>
# ----- Proxy setup -----<br/>
# Uncomment if using a proxy server.<br/>
#proxy.host=proxy.domain<br/>
#proxy.port=8080<br/>
#proxy.use=on<br/>
<br/>
# ----- Default Base Path for Dependent Packages -----<br/>
# Replace this path with the directory path where<br/>
# dependencies binaries should be downloaded.<br/>
base.path=/usr/share/java<br/>
</code>
</p>
</section>
<section name="Updating and rebuilding Tomcat sources">
<p>
It is recommended to regularly update the downloaded Tomcat 5 sources.
To do this, execute the following commands:
<code><br/>
cd ${tomcat.source}<br/>
ant checkout<br/>
</code>
</p>
<p>
For a quick rebuild of only modified code you can use:
<code><br/>
cd ${tomcat.source}<br/>
ant build<br/>
</code>
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
