Author: kkolinko
Date: Sat Nov 22 14:17:36 2014
New Revision: 1641067
URL: http://svn.apache.org/r1641067
Log:
Improvements to building.xml:
Add link to BUILDING.txt
Introduce section "Configure download area" and describe build.properties file
and download settings there.
Mention java-compiler-errors-warnings.txt file for Eclipse IDE.
Merged revisions r1641058, r1641064 from tomcat/trunk.
Modified:
tomcat/tc8.0.x/trunk/ (props changed)
tomcat/tc8.0.x/trunk/webapps/docs/building.xml
tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
Merged /tomcat/trunk:r1641058,1641064
Modified: tomcat/tc8.0.x/trunk/webapps/docs/building.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/building.xml?rev=1641067&r1=1641066&r2=1641067&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/building.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/building.xml Sat Nov 22 14:17:36 2014
@@ -23,7 +23,6 @@
&project;
<properties>
- <author>Remy Maucherat, Tim Whittington</author>
<title>Building Tomcat</title>
</properties>
@@ -36,8 +35,10 @@
<section name="Introduction">
<p>
-Building Apache Tomcat from source is very easy, and is the first step to
contributing to
-Tomcat. The following is a step by step guide.
+Building Apache Tomcat from source is very easy, and is the first step to
+contributing to Tomcat. The complete and comprehensive instructions are
+provided in the file <a href="BUILDING.txt">BUILDING.txt</a>.
+The following is a quick step by step guide.
</p>
</section>
@@ -103,48 +104,71 @@ available, which will be used to actuall
</section>
-<section name="Building Tomcat">
+<section name="Configure download area">
<p>
-Use the following commands to build Tomcat:
-<br/><br/>
-<code>
- cd ${tomcat.source}<br/>
- ant
-</code>
+ Building Tomcat involves downloading a number of libraries that it depends
on.
+ It is strongly recommended to configure download area for those libraries.
</p>
<p>
-<b>WARNING:</b> Running this command will download libraries required
- to build Tomcat to the <code>/usr/share/java</code> directory by default.
- On a typical Linux or MacOX system, an ordinary user
- will not have access to write to this directory, and, even if you do,
- it is likely not appropriate for you to write there. On Windows
- this usually corresponds to the <code>C:\usr\share\java</code> directory,
- unless Cygwin is used. Read below to learn how to customize the directory
- used to download the binaries.
+ By default the build is configured to download dependencies into directory
+ <code>/usr/share/java</code>. On a typical Linux or MacOX system, an ordinary
+ user will not have access to write to this directory, and, even if you do,
+ it is likely not appropriate for you to write there. On Windows this usually
+ corresponds to the <code>C:\usr\share\java</code> directory, unless Cygwin is
+ used.
</p>
<p>
-<b>NOTE:</b> Users accessing the Internet through a proxy must use a properties
- file to indicate to Ant the proxy configuration. Read below for details.
+ The build is controlled by creating a
+ <code>${tomcat.source}/build.properties</code> file. It can be used to
+ redefine any property that is present in
<code>build.properties.default</code>
+ and <code>build.xml</code> files. The <code>build.properties</code> file
+ does not exist by default. You have to create it.
</p>
<p>
- The build can be controlled by creating a
<code>${tomcat.source}/build.properties</code>
- file and adding the following content to it:
+ The download area is defined by property <code>base.path</code>. For example:
</p>
-<source># ----- Proxy setup -----
-# Uncomment if using a proxy server.
-#proxy.host=proxy.domain
-#proxy.port=8080
-#proxy.use=on
-# ----- Default Base Path for Dependent Packages -----
+<source><![CDATA[# ----- Default Base Path for Dependent Packages -----
# Replace this path with the directory path where
# dependencies binaries should be downloaded.
-base.path=/home/me/some-place-to-download-to</source>
+base.path=/home/me/some-place-to-download-to]]></source>
+
+<p>
+ Different versions of Tomcat are allowed to share the same download area.
+</p>
+
+<p>
+ Another example:
+</p>
+
+<source>base.path=${user.dir}/../libraries-tomcat<version-major-minor/></source>
+
+<p>
+ Users who access the Internet through a proxy must use the properties
+ file to indicate to Ant the proxy configuration:
+</p>
+
+<source><![CDATA[# ----- Proxy setup -----
+proxy.host=proxy.domain
+proxy.port=8080
+proxy.use=on]]></source>
+
+</section>
+
+<section name="Building Tomcat">
+
+<p>
+Use the following commands to build Tomcat:
+</p>
+<p>
+<code>cd ${tomcat.source}</code><br/>
+<code>ant</code>
+</p>
<p>
Once the build has completed successfully, a usable Tomcat installation will
have been
@@ -186,11 +210,11 @@ The instructions below will automaticall
<p>
An Ant target is provided as a convenience to download all binary
dependencies, and to create
the Eclipse project and classpath files in the root of the source tree.
-<br/>
-<code><br/>
- cd ${tomcat.source}<br/>
- ant ide-eclipse<br/>
-</code>
+</p>
+
+<p>
+<code>cd ${tomcat.source}</code><br/>
+<code>ant ide-eclipse</code>
</p>
<p>
@@ -220,7 +244,7 @@ and import the Tomcat project located th
<code>start-tomcat</code> and <code>stop-tomcat</code> launch configurations
are provided in
<code>res/ide-support/eclipse</code> and will be available in the
<em>Run->Run Configurations</em>
dialog. Use these to start and stop Tomcat from Eclipse.
-<br/>If you want to configure these yourself (or are using a different IDE)
+If you want to configure these yourself (or are using a different IDE)
then use <code>org.apache.catalina.startup.Bootstrap</code> as the main class,
<code>start</code>/<code>stop</code> etc. as program arguments, and specify
<code>-Dcatalina.home=...</code>
(with the name of your build directory) as VM arguments.
@@ -240,6 +264,10 @@ coding conventions (and have your contri
<tr><td>Ant -> Editor -> Formatter</td><td>Tab size: 2<br/>Use tab
character instead of spaces: unchecked</td></tr>
</table>
+<p>
+The recommended configuration of Compiler Warnings is documented in
+<code>res/ide-support/eclipse/java-compiler-errors-warnings.txt</code> file.
+</p>
</section>
Modified: tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml?rev=1641067&r1=1641066&r2=1641067&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml Sat Nov 22 14:17:36 2014
@@ -108,6 +108,10 @@
declaration into web application instead of enabling it globally.
Correct documentation for cgiPathPrefix. (kkolinko)
</fix>
+ <update>
+ Improve HTML version of build instructions and align with
+ BUILDING.txt. (kkolinko)
+ </update>
</changelog>
</subsection>
<subsection name="Other">
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
