You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2006/10/13 17:13:59 UTC

svn commit: r463702 - in /tomcat/tc6.0.x/trunk: build.properties.default extras.xml webapps/docs/building.xml webapps/docs/extras.xml webapps/docs/logging.xml webapps/docs/project.xml

Author: remm
Date: Fri Oct 13 08:13:57 2006
New Revision: 463702

URL: http://svn.apache.org/viewvc?view=rev&rev=463702
Log:
- Add a build script to build extras.
- Update the logging documentation.

Added:
    tomcat/tc6.0.x/trunk/extras.xml   (with props)
    tomcat/tc6.0.x/trunk/webapps/docs/extras.xml   (with props)
Modified:
    tomcat/tc6.0.x/trunk/build.properties.default
    tomcat/tc6.0.x/trunk/webapps/docs/building.xml
    tomcat/tc6.0.x/trunk/webapps/docs/logging.xml
    tomcat/tc6.0.x/trunk/webapps/docs/project.xml

Modified: tomcat/tc6.0.x/trunk/build.properties.default
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/build.properties.default?view=diff&rev=463702&r1=463701&r2=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/build.properties.default (original)
+++ tomcat/tc6.0.x/trunk/build.properties.default Fri Oct 13 08:13:57 2006
@@ -24,12 +24,8 @@
 base-jakarta.loc=http://archive.apache.org/dist/jakarta
 base-tomcat.loc=http://archive.apache.org/dist/tomcat
 
-# ----- Commons Logging, version 1.0.1 or later -----
-commons-logging.home=${base.path}/commons-logging-1.0.4
-commons-logging.lib=${commons-logging.home}
-commons-logging-api.jar=${commons-logging.lib}/commons-logging-api.jar
-commons-logging.jar=${commons-logging.lib}/commons-logging.jar
-commons-logging.loc=${base-jakarta.loc}/commons/logging/binaries/commons-logging-1.0.4.tar.gz
+# ----- Commons Logging, version 1.1 or later -----
+commons-logging-src.loc=${base-jakarta.loc}/commons/logging/source/commons-logging-1.1-src.tar.gz
 
 # ----- Eclipse JDT, version 3.2 or later -----
 jdt.home=${base.path}/eclipse/plugins

Added: tomcat/tc6.0.x/trunk/extras.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/extras.xml?view=auto&rev=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/extras.xml (added)
+++ tomcat/tc6.0.x/trunk/extras.xml Fri Oct 13 08:13:57 2006
@@ -0,0 +1,175 @@
+<project name="Tomcat 6.0" default="extras" basedir=".">
+
+
+  <!-- ===================== Initialize Property Values =================== -->
+
+  <!-- See "build.properties.sample" in the top level directory for all     -->
+  <!-- property values you must customize for successful building!!!        -->
+  <property file="${user.home}/build.properties"/>
+  <property file="build.properties"/>
+
+  <property file="build.properties.default"/>
+
+  <!-- Project Properties -->
+  <property name="name"                  value="Apache Tomcat" />
+  <property name="year"                  value="2006" />
+  <property name="version.major"         value="6" />
+  <property name="version.minor"         value="0" />
+  <property name="version.build"         value="0" />
+  <property name="version.patch"         value="0" />
+  <property name="version"               value="6.0.0-dev" />
+  <property name="version.number"        value="${version.major}.${version.minor}.${version.build}.${version.patch}" />
+
+  <property name="project"               value="apache-tomcat" />
+  <property name="final.name"            value="${project}-${version}" />
+  <property name="final-src.name"        value="${project}-${version}-src" />
+
+  <!-- Build Defaults -->
+  <property name="tomcat.build"      value="${basedir}/output/build"/>
+  <property name="tomcat.classes"    value="${basedir}/output/classes"/>
+  <property name="tomcat.dist"       value="${basedir}/output/dist"/>
+  <property name="tomcat.extras"     value="${basedir}/output/extras"/>
+  <property name="tomcat.deployer"   value="${basedir}/output/deployer"/>
+  <property name="tomcat.release"    value="${basedir}/output/release"/>
+  <property name="test.failonerror"  value="true"/>
+  <property name="test.runner"       value="junit.textui.TestRunner"/>
+
+  <!-- Can't be lower - jsp uses templates -->
+  <property name="compile.source" value="1.5"/>
+
+  <!-- JAR artifacts -->
+  <property name="bootstrap.jar" value="${tomcat.build}/bin/bootstrap.jar"/>
+
+  <property name="annotations-api.jar" value="${tomcat.build}/lib/annotations-api.jar"/>
+  <property name="servlet-api.jar" value="${tomcat.build}/lib/servlet-api.jar"/>
+  <property name="jsp-api.jar" value="${tomcat.build}/lib/jsp-api.jar"/>
+  <property name="el-api.jar" value="${tomcat.build}/lib/el-api.jar"/>
+  <property name="catalina.jar" value="${tomcat.build}/lib/catalina.jar"/>
+  <property name="catalina-ant.jar" value="${tomcat.build}/lib/catalina-ant.jar"/>
+  <property name="catalina-ant-jmx.jar" value="${tomcat.build}/lib/catalina-ant-jmx.jar"/>
+  <property name="tomcat-coyote.jar" value="${tomcat.build}/lib/tomcat-coyote.jar"/>
+
+  <property name="jasper.jar" value="${tomcat.build}/lib/jasper.jar"/>
+  <property name="jasper-el.jar" value="${tomcat.build}/lib/jasper-el.jar"/>
+
+  <property name="tomcat-dbcp.home" value="${base.path}/tomcat6-deps/dbcp" />
+  <property name="jasper-jdt.home" value="${base.path}/tomcat6-deps/jdt" />
+  <property name="tomcat-dbcp.jar" value="${tomcat-dbcp.home}/tomcat-dbcp.jar"/>
+  <property name="jasper-jdt.jar" value="${jasper-jdt.home}/jasper-jdt.jar"/>
+
+  <property name="tomcat-juli.jar" value="${tomcat.extras}/tomcat-juli.jar"/>
+  <property name="tomcat-juli-adapters.jar" value="${tomcat.extras}/tomcat-juli-adapters.jar"/>
+	
+  <!-- Classpath -->
+  <path id="tomcat.classpath">
+    <pathelement location="${tomcat.classes}"/>
+  </path>
+
+  <target name="prepare">
+    <mkdir dir="${tomcat.extras}"/>
+  </target>
+
+  <target name="clean">
+  	<delete dir="${tomcat.extras}"/>
+  </target>
+
+  <target name="commons-logging">
+    
+    <antcall target="downloadfile">
+      <param name="sourcefile" value="${commons-logging-src.loc}"/>
+      <param name="destfile" value="${tomcat.extras}/logging/commons-logging-src.tar.gz"/>
+      <param name="destdir" value="${tomcat.extras}/logging/"/>
+    </antcall>
+    <gunzip src="${tomcat.extras}/logging/commons-logging-src.tar.gz" 
+    	dest="${tomcat.extras}/logging/commons-logging-src.tar"/>
+    <untar src="${tomcat.extras}/logging/commons-logging-src.tar" 
+    	dest="${tomcat.extras}/logging/"/>
+  	
+    <replace dir="${tomcat.extras}/logging/commons-logging-1.1-src/src/java/org/apache/commons" >
+      <replacefilter token="org.apache.commons"
+            value="org.apache.juli" />
+    </replace>
+    <mkdir dir="${tomcat.extras}/logging/commons-logging-1.1-src/src/java/org/apache/juli" />
+    <move todir="${tomcat.extras}/logging/commons-logging-1.1-src/src/java/org/apache/juli">
+      <fileset dir="${tomcat.extras}/logging/commons-logging-1.1-src/src/java/org/apache/commons" />
+    </move>
+
+    <replace dir="${tomcat.extras}/logging/commons-logging-1.1-src" >
+      <replacefilter token="org.apache.commons"
+            value="org.apache.juli" />
+        <replacefilter token="org/apache/commons/"
+              value="org/apache/juli/" />
+    </replace>
+    <copy tofile="${tomcat.extras}/logging/commons-logging-1.1-src/build2.xml" 
+    	file="${tomcat.extras}/logging/commons-logging-1.1-src/build.xml" />
+
+  	<ant antfile="${tomcat.extras}/logging/commons-logging-1.1-src/build2.xml"
+  	     dir="${tomcat.extras}/logging/commons-logging-1.1-src" 
+  	     target="getlibs" />
+    <copy todir="${tomcat.extras}/logging/commons-logging-1.1-src">
+      <fileset dir="${tomcat.extras}/logging/commons-logging-1.1-src/lib" />
+    </copy>
+  	<ant antfile="${tomcat.extras}/logging/commons-logging-1.1-src/build2.xml"
+  	     dir="${tomcat.extras}/logging/commons-logging-1.1-src"
+  	     target="compile" />
+  
+    <jar jarfile="${tomcat-juli.jar}">
+      <fileset dir="${tomcat.extras}/logging/commons-logging-1.1-src/target/classes">
+        <include name="org/apache/juli/logging/*.class" /> 
+        <include name="org/apache/juli/logging/impl/LogFactoryImpl*.class" /> 
+        <include name="org/apache/juli/logging/impl/WeakHashtable*.class" /> 
+        <include name="org/apache/juli/logging/impl/SimpleLog*.class" /> 
+        <include name="org/apache/juli/logging/impl/NoOpLog*.class" /> 
+        <include name="org/apache/juli/logging/impl/Jdk14Logger.class" /> 
+        <include name="META-INF/LICENSE.txt" /> 
+        <include name="META-INF/NOTICE.txt" /> 
+        <!-- Javadoc and i18n exclusions -->
+        <exclude name="**/package.html" />
+        <exclude name="**/LocalStrings_*" />
+      </fileset>
+      <fileset dir="${tomcat.classes}">
+        <include name="org/apache/juli/*" />
+        <!-- Javadoc and i18n exclusions -->
+        <exclude name="**/package.html" />
+        <exclude name="**/LocalStrings_*" />
+      </fileset>
+    </jar>
+
+    <jar jarfile="${tomcat-juli-adapters.jar}">
+      <fileset dir="${tomcat.extras}/logging/commons-logging-1.1-src/target/classes">
+        <include name="org/apache/juli/logging/impl/**.class" /> 
+        <exclude name="org/apache/juli/logging/impl/WeakHashtable*.class" /> 
+        <exclude name="org/apache/juli/logging/impl/LogFactoryImpl.class" /> 
+        <include name="META-INF/LICENSE.txt" /> 
+        <include name="META-INF/NOTICE.txt" /> 
+        <!-- Javadoc and i18n exclusions -->
+        <exclude name="**/package.html" />
+        <exclude name="**/LocalStrings_*" />
+      </fileset>
+    </jar>
+
+  </target>
+
+  <target name="extras" depends="prepare,commons-logging">
+  </target>
+
+  <!-- Download and dependency building -->
+  <target name="setproxy"  if="useproxy">
+    <taskdef name="setproxy"
+            classname="org.apache.tools.ant.taskdefs.optional.net.SetProxy" />
+    <setproxy proxyhost="${proxy.host}" proxyport="${proxy.port}"/>
+    <echo message="Using ${proxy.host}:${proxy.port} to download ${sourcefile}"/>
+  </target>
+
+  <target name="testexist">
+    <echo message="Testing  for ${destfile}"/>
+    <available file="${destfile}" property="exist"/>
+  </target>
+
+  <target name="downloadfile" unless="exist" depends="setproxy,testexist">
+    <!-- Download extract the file -->
+    <mkdir dir="${destdir}" />
+    <get src="${sourcefile}" dest="${destfile}" />
+  </target>
+
+</project>

Propchange: tomcat/tc6.0.x/trunk/extras.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: tomcat/tc6.0.x/trunk/webapps/docs/building.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/building.xml?view=diff&rev=463702&r1=463701&r2=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/building.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/building.xml Fri Oct 13 08:13:57 2006
@@ -16,20 +16,13 @@
 <section name="Introduction">
 
 <p>
-Building Tomcat from SVN is very easy, and is the first step to contributing to
+Building Apache Tomcat from SVN 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>
-The default distribution of Tomcat 5.5.x requires a 5.0 or later JDK. Tomcat
-can be built using a 1.4.x JDK but you will need to copy the contents of the
-compat directory (created by the build process) to your build directory before
-Tomcat will start.
-</p>
+<section name="Download a Java Development Kit (JDK) release (version 1.5.x or later)">
 
 <p>
 The Sun JDK can be downloaded <a href="http://java.sun.com/j2se/">here</a>.
@@ -42,10 +35,10 @@
 
 </section>
 
-<section name="Install Apache Ant 1.6.2 or later">
+<section name="Install Apache Ant 1.6.5 or later">
 
 <p>
-Download a binary distribution of Ant 1.6.2 or later from 
+Download a binary distribution of Ant 1.6.5 or later from 
 <a href="http://ant.apache.org/bindownload.cgi">here</a>.
 </p>
 
@@ -66,22 +59,35 @@
 
 </section>
 
-<section name="Building Tomcat">
+<section name="Checkout or obtain the source code for Tomcat 6.0">
 
-<p>
-Download the main build.xml script from <a href="build.xml">here</a>.
-</p>
+  <p>
+  Tomcat SVN repository URL:
+  <code>http://svn.apache.org/repos/asf/tomcat/tc6.0.x/</code>
+  </p>
+  
+  <p>
+  Download a source package from:
+  <code>http://tomcat.apache.org/download-60.cgi</code>
+  </p>
+  
+  <p>
+  Checkout the source using SVN, selecting the desired version or
+  branch (current development source is at 
+  <code>http://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk/</code>), or 
+  unpack the source package. The location where the source has been
+  placed will be referred as ${tomcat.source}.
+  </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>
+</section>
+
+<section name="Building Tomcat">
 
 <p>
-Go to that directory, and do:
+Use the following commands:
 <code><br/>
     cd ${tomcat.source}<br/>
+    ant download<br/>
     ant<br/>
 </code>
 </p>
@@ -92,8 +98,8 @@
 </p>
 
 <p>
-WARNING: Running this command will checkout the Tomcat 5 sources from SVN, as
-  well as download binaries to the <code>/usr/share/java</code> directory. 
+WARNING: Running this command will 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 
@@ -115,29 +121,6 @@
     # 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>

Added: tomcat/tc6.0.x/trunk/webapps/docs/extras.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/extras.xml?view=auto&rev=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/extras.xml (added)
+++ tomcat/tc6.0.x/trunk/webapps/docs/extras.xml Fri Oct 13 08:13:57 2006
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<!DOCTYPE document [
+  <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="extras.html">
+
+    &project;
+
+  <properties>
+    <title>Additional Components</title>
+    <author>Remy Maucherat</author>
+  </properties>
+
+<body>
+
+  <section name="Introduction">
+  <p>
+    A number of additional third party components may be used with Apache Tomcat, but are not
+    provided directly in the downlad bundle for a variety of reasons. These may be built by
+    users should they need it.
+  </p>
+
+  </section>
+
+  <section name="Building">
+
+    <p>
+      The additional components are built using the <code>extras.xml</code> Ant script which is
+      present in the source bundle of Tomcat.
+    </p>
+    
+    <p>The build process is the following:</p>
+    
+    <ul>
+    <li>Follow the <a href="building.html">build instructions</a> to build a Tomcat binary from
+    the source bundle (note: it will be used by the build process of the additional components, but
+    does not need to be actually used later on)</li>
+    <li>Execute the command <code>ant -f extras.xml</code> to run the build script</li>
+    <li>The additional components JARs will be placed in the <code>output/extras</code> folder</li>
+    <li>Refer to the documentation below about the usage of these JARs</li>
+    </ul>
+	
+  </section>
+
+  <section name="Commons-logging">
+
+  <p>
+    Tomcat uses a package renamed commons-logging API implementation which is hardcoded to use
+    the java.util.logging API. The commons-logging additional component builds a full fledged
+    package renames commons-logging implementation which can be used to replace the implementation
+    provided with Tomcat. See the <a href="logging.html">logging</a> page for usage instructions.
+  </p>
+
+  </section>
+
+</body>
+</document>

Propchange: tomcat/tc6.0.x/trunk/webapps/docs/extras.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: tomcat/tc6.0.x/trunk/webapps/docs/logging.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/logging.xml?view=diff&rev=463702&r1=463701&r2=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/logging.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/logging.xml Fri Oct 13 08:13:57 2006
@@ -14,6 +14,16 @@
 
 <body>
 
+  <section name="Important note">
+  <p>
+    By default, only java.util.logging is available for the core Tomcat, as Tomcat uses
+    a package renamed logging implementation which is hardcoded for that logger. Usage of
+    alternate loggers is available after building the extra components (see
+    the <a href="extras.html">extras components</a> documentation), which includes
+    a full commons-logging implementation.
+  </p>
+  </section>
+  
   <section name="Introduction">
   <p>
     Tomcat 6.0 uses 
@@ -61,7 +71,7 @@
     <p>
       <ol>
         <li>Create a file called log4j.properties with the following content 
-            and save it into common/classes.
+            and save it into $CATALINA_HOME/lib.
           <source>
             log4j.rootLogger=debug, R <br />
             log4j.appender.R=org.apache.log4j.RollingFileAppender <br />
@@ -75,12 +85,16 @@
 	</li>
 
 	<li><a href="http://logging.apache.org/log4j">Download Log4J</a> 
-            (v1.2 or later) and place the log4j jar in $CATALINA_HOME/common/lib.</li>
+            (v1.2 or later) and place the log4j jar in $CATALINA_HOME/lib.</li>
+
+        <li>Build the commons-logging additional component using the extras.xml
+        Ant build script which is part of teh Tomcat source bundle.</li>
+        
+        <li>Replace <code>$CATALINA_HOME/bin/tomcat-juli.jar</code> with
+        <code>output/extras/tomcat-juli.jar</code>.</li>
 
-        <li><a href="http://jakarta.apache.org/site/downloads/downloads_commons-logging.cgi">
-            Download Commons Logging</a> and place the commons-logging.jar 
-            (not commons-logging-api.jar) in $CATALINA_HOME/common/lib with 
-            the log4j jar.</li>
+        <li>Place <code>$CATALINA_HOME/bin/tomcat-juli-adapters.jar</code> in 
+        $CATALINA_HOME/lib.</li>
 
 	<li>Start Tomcat</li>
       </ol>

Modified: tomcat/tc6.0.x/trunk/webapps/docs/project.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/project.xml?view=diff&rev=463702&r1=463701&r2=463702
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/project.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/project.xml Fri Oct 13 08:13:57 2006
@@ -45,6 +45,8 @@
         <item name="22) Logging"            href="logging.html"/>
         <item name="23) APR"                href="apr.html"/>
         <item name="24) Advanced IO"        href="aio.html"/>
+        <item name="25) Additional Components"
+              href="extras.html"/>
     </menu>
 
     <menu name="Reference">



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: svn commit: r463702 - in /tomcat/tc6.0.x/trunk: build.properties.default extras.xml webapps/docs/building.xml webapps/docs/extras.xml webapps/docs/logging.xml webapps/docs/project.xml

Posted by Filip Hanik - Dev Lists <de...@hanik.com>.
Remy Maucherat wrote:
> remm@apache.org wrote:
>> Author: remm
>> Date: Fri Oct 13 08:13:57 2006
>> New Revision: 463702
>>
>> URL: http://svn.apache.org/viewvc?view=rev&rev=463702
>> Log:
>> - Add a build script to build extras.
>> - Update the logging documentation.
>
> More funky optional package renamed stuff ;)
>
> I wanted to add the possibility to have the same feature level as on 
> TC 5.5 (ex: use log4j for the whole Tomcat, which I tested).

    yes, this is a very popular feature where we run Tomcat, cause the
    operations teams are in control of the logging for all apps

>
> Rémy
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: svn commit: r463702 - in /tomcat/tc6.0.x/trunk: build.properties.default extras.xml webapps/docs/building.xml webapps/docs/extras.xml webapps/docs/logging.xml webapps/docs/project.xml

Posted by Remy Maucherat <re...@apache.org>.
remm@apache.org wrote:
> Author: remm
> Date: Fri Oct 13 08:13:57 2006
> New Revision: 463702
> 
> URL: http://svn.apache.org/viewvc?view=rev&rev=463702
> Log:
> - Add a build script to build extras.
> - Update the logging documentation.

More funky optional package renamed stuff ;)

I wanted to add the possibility to have the same feature level as on TC 
5.5 (ex: use log4j for the whole Tomcat, which I tested).

Rémy

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org