Author: yoavs Date: Sun Dec 24 09:41:23 2006 New Revision: 490052 URL: http://svn.apache.org/viewvc?view=rev&rev=490052 Log: Bugzilla 37977: building documentation improvements
Modified: tomcat/build/tc5.5.x/BUILDING.txt tomcat/build/tc5.5.x/build.properties.default tomcat/build/tc5.5.x/resources/build.xml tomcat/container/tc5.5.x/webapps/docs/building.xml tomcat/container/tc5.5.x/webapps/docs/changelog.xml Modified: tomcat/build/tc5.5.x/BUILDING.txt URL: http://svn.apache.org/viewvc/tomcat/build/tc5.5.x/BUILDING.txt?view=diff&rev=490052&r1=490051&r2=490052 ============================================================================== --- tomcat/build/tc5.5.x/BUILDING.txt (original) +++ tomcat/build/tc5.5.x/BUILDING.txt Sun Dec 24 09:41:23 2006 @@ -47,9 +47,29 @@ available, which will be used to actually perform the build. -(2) Building Tomcat 5.5 +(2) Install Subversion 1.3.x on your computer -(2.1) Download main build script and build binary distribution +* If Subversion 1.3.x is already installed on your computer, skip to (3). + +* Download a binary distribution of Subversion 1.3.x from: + + http://subversion.tigris.org/project_packages.html + +* Unpack the binary distribution into a convenient location so that the + Subversion release resides in its own directory. + +* Modify the PATH environment variable to include the directory + ${svn.home}/bin in its list, where "${svn.home}" is the full pathname + of the subversion release directory. This makes the "svn" command + available, which will be used to checkout the tomcat sources. + +* NOTE: If you're running behind a proxy server, the SVN checkout of Tomcat + source code may fail. See http://subversion.tigris.org/faq.html#proxy for + ways to work around this. + +(3) Building Tomcat 5.5 + +(3.1) Download main build script and build binary distribution * Download the main build.xml script from: http://tomcat.apache.org/tomcat-5.5-doc/build.xml @@ -58,7 +78,7 @@ directory will be referred to as the ${tomcat.source} directory in the rest of this document -(2.2) Building +(3.2) Building * Go to that directory, and do: @@ -90,7 +110,7 @@ base.path=/usr/share/java -(3) Updating sources +(4) Updating sources It is recommended that you regularly update the downloaded Tomcat 5 sources. To do this, execute the following commands: @@ -99,7 +119,7 @@ ant checkout -(4) Rebuilds +(5) Rebuilds For a quick rebuild of only modified code you can use @@ -110,7 +130,7 @@ tomcat depends on ( commons-logging for now ), to ease fixes and debuging in those packages. -(5) Building The "compat" Package +(6) Building The "compat" Package Tomcat 5.5 is designed to run on J2SE 5.0, but will run on J2SE versions 1.3 and 1.4 as well as long as the compatability @@ -121,13 +141,13 @@ cd ${tomcat.source} ant build-compat -(6) Building the servlet and jsp API documentation +(7) Building the servlet and jsp API documentation The documentation can be easly rebuild, do cd ${tomcat.source}/build ant dist-javadoc -(7) Building a release running tests: +(8) Building a release running tests: do cd ${tomcat.source}/build Modified: tomcat/build/tc5.5.x/build.properties.default URL: http://svn.apache.org/viewvc/tomcat/build/tc5.5.x/build.properties.default?view=diff&rev=490052&r1=490051&r2=490052 ============================================================================== --- tomcat/build/tc5.5.x/build.properties.default (original) +++ tomcat/build/tc5.5.x/build.properties.default Sun Dec 24 09:41:23 2006 @@ -142,9 +142,9 @@ # ----- Tomcat native library ----- -tomcat-native.home=${base.path}/tomcat-native-1.1.7 +tomcat-native.home=${base.path}/tomcat-native-current tomcat-native.tar.gz=${tomcat-native.home}/tomcat-native.tar.gz -tomcat-native.loc=${base-tomcat.loc}/tomcat-connectors/native/tomcat-native-1.1.7.tar.gz +tomcat-native.loc=${base-tomcat.loc}/tomcat-connectors/native/tomcat-native-current.tar.gz # -------------------------------------------------- Modified: tomcat/build/tc5.5.x/resources/build.xml URL: http://svn.apache.org/viewvc/tomcat/build/tc5.5.x/resources/build.xml?view=diff&rev=490052&r1=490051&r2=490052 ============================================================================== --- tomcat/build/tc5.5.x/resources/build.xml (original) +++ tomcat/build/tc5.5.x/resources/build.xml Sun Dec 24 09:41:23 2006 @@ -1,5 +1,6 @@ -<project name="Tomcat 5.0 Netbuild" default="build" basedir="."> - +<!-- This file is the Tomcat 5.x net build file. It's what users run to build Tomcat --> +<!-- from scratch. See BUILDING.txt for the full instructions. --> +<project name="Tomcat 5 Netbuild" default="build" basedir="."> <!-- ===================== Initialize Property Values =================== --> @@ -11,9 +12,9 @@ <!-- Project Properties --> <property name="name" value="Apache Tomcat" /> - <property name="year" value="2005" /> + <property name="year" value="2006" /> <property name="version" value="5.5" /> - <property name="project" value="jakarta-tomcat" /> + <property name="project" value="apache-tomcat" /> <property name="final.name" value="${project}-${version}" /> <property name="final-src.name" value="${project}-${version}-src" /> @@ -65,10 +66,18 @@ description="Update or checkout required sources from SVN"> <echo level="info" - message="If the checkout fails, - todo - " /> + message="If the checkout fails, see http://tomcat.apache.org/svn.html and http://subversion.tigris.org/faq.html#proxy" /> - <exec dir="${basedir}" executable="svn"> - <arg line="checkout ${svnroot}/${current.loc} ${basedir}" /> + <!-- Bugzilla 37977: http://issues.apache.org/bugzilla/show_bug.cgi?id=37977 --> + <!-- hackish: inputstring="t${line.separator}" is t+<enter> for svn --> + <!-- to temporarily accept the certificate of svn.apache.org. --> + <exec dir="${basedir}" + executable="svn" + inputstring="t${line.separator}" + failonerror="true"> + <arg value="checkout" /> + <arg value="${svnroot}/${current.loc}" /> + <arg value="${basedir}" /> </exec> </target> Modified: tomcat/container/tc5.5.x/webapps/docs/building.xml URL: http://svn.apache.org/viewvc/tomcat/container/tc5.5.x/webapps/docs/building.xml?view=diff&rev=490052&r1=490051&r2=490052 ============================================================================== --- tomcat/container/tc5.5.x/webapps/docs/building.xml (original) +++ tomcat/container/tc5.5.x/webapps/docs/building.xml Sun Dec 24 09:41:23 2006 @@ -13,6 +13,13 @@ <body> +<section name="README"> +<p> +This document duplicates some of the information from the BUILDING.txt file +included in every Tomcat distribution. You may want to consult both. +</p> +</section> + <section name="Introduction"> <p> @@ -167,6 +174,10 @@ under the IDE, and so on. </p> +<p>You will want to set up your Eclipse project for building Tomcat such that +${tomcatSource} is the Workspace folder. +</p> + <p> Use Windows->Preferences and then Java->Build Path->Classpath Variables to add two new Classpath variables: @@ -183,8 +194,9 @@ Use File->New Project to create a new Java project for each of the binaries repository (e.g., /usr/share/java), container, connectors, jasper, servletapi. -Unless you thought ahead to make the ${tomcat.source} directory be under -your Workspace folder, tell Eclipse the external location using "Import/Export...", +If you didn't already set up the Eclipse project such that ${tomcat.source} +is the Workspace folder, do so now: +tell Eclipse the external location using "Import/Export...", General->Existing Project into Workspace. </p> Modified: tomcat/container/tc5.5.x/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/container/tc5.5.x/webapps/docs/changelog.xml?view=diff&rev=490052&r1=490051&r2=490052 ============================================================================== --- tomcat/container/tc5.5.x/webapps/docs/changelog.xml (original) +++ tomcat/container/tc5.5.x/webapps/docs/changelog.xml Sun Dec 24 09:41:23 2006 @@ -156,6 +156,10 @@ notify users of missing MailSessionFactory in distribution, suggest workarounds, and link to relevant Bugzilla issue. (yoavs) </fix> + <fix> + <bug>37977</bug>: adapt BUILDING.txt and net build.xml for SVN. Patch by + Christopher Sahnwaldt. (yoavs) + </fix> </changelog> </subsection> <subsection name="Coyote"> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]