svn commit: r232995 - /beehive/trunk/distribution.xml

[ek...@apache.org]

Author: ekoneil
Date: Tue Aug 16 06:34:12 2005
New Revision: 232995

URL: http://svn.apache.org/viewcvs?rev=232995&view=rev
Log:
Add new target in distribution.xml that stages the release documentation for use in either the distribution or on the website.  This makes it very easy to package the release (or nightly) docs for uploading to Apache servers without having to build an entire Beehive distribution.

BB: self
DRT: build.dist pass


Modified:
    beehive/trunk/distribution.xml

Modified: beehive/trunk/distribution.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/distribution.xml?rev=232995&r1=232994&r2=232995&view=diff
==============================================================================
--- beehive/trunk/distribution.xml (original)
+++ beehive/trunk/distribution.xml Tue Aug 16 06:34:12 2005
@@ -53,6 +53,8 @@
     <property name="dist.readme.rev.trailer" location="${beehive.home}/docs/dist-docs/rev-readme-trailer.txt"/>
     <property name="dist.readme.toplvl.trailer" location="${beehive.home}/docs/dist-docs/toplvl-readme-trailer.txt"/>
 
+    <property name="release.docs.build.dir" location="${beehive.home}/build/release-docs"/>
+
     <!-- Properties used by the "build.dist*.{tgz,zip}" targets for translating end-of-line characters in text files -->
     <property name="text.file.includes.unix" value="**/*.beaninfo,**/*.css,**/*.dtd,**/*.html,**/*.inc,**/*.java,**/*.jcs,**/*.jcx,**/*.jj,**/*.jpf,**/*.jpfs,**/*.js,**/*.jsfb,**/*.jsp,**/*.jspf,**/*.jspx,**/*.jws,**/*.log,**/*.properties,**/*.sql,**/*.tag,**/*.tld,**/*.txt,**/*.TXT,**/*.wsdd,**/*.wsdl,**/*.xml,**/*.xsd,**/*.xsdconfig,**/*.xsl,**/*.xslt,**/Global.app"/>
     <property name="text.file.includes.dos" value="**/*.bat,**/*.cmd,${text.file.includes.unix}"/>
@@ -333,22 +335,11 @@
         </copy>
     </target>
 
-    <target name="build.dist.docs" unless="skip.docs" description="Builds documentation for a Beehive distribution">
-
-        <mkdir dir="${dist.dir}"/>
-
-        <ant antfile="build.xml" target="docs" inheritAll="false"/>    
-
-        <!-- copy javadocs to dist -->
-        <copy todir="${dist.dir}/docs/apidocs" failOnError="true">
-            <fileset dir="controls/build/docs/apidocs"/>
-            <fileset dir="netui/build/docs/apidocs"/>
-            <fileset dir="wsm/build/docs/apidocs"/>
-            <fileset dir="system-controls/build/docs/apidocs"/>
-        </copy>
+    <target name="build.dist.docs" description="Build the documentation for a Beehive distribution">
+        <antcall target="build.release.docs"/>
         
         <copy todir="${dist.dir}/docs" failOnError="true">
-            <fileset dir="docs/forrest/release/build/site"/>
+            <fileset dir="${release.docs.build.dir}"/>
         </copy>
 
         <copy todir="${dist.dir}/docs" failOnError="true">
@@ -361,6 +352,27 @@
         <!-- copy the readme and update it to include the revision number -->
         <copy file="${dist.readme.template}" tofile="${dist.dir}/docs/README.txt" overwrite="true" verbose="true"/>
         <build-dist-readme readmedir="${dist.dir}/docs" revtrailer="${dist.readme.rev.trailer}"/>
+    </target>
+
+    <target name="build.release.docs" unless="skip.docs" description="Builds documentation for a Beehive distribution">
+
+        <property name="release.docs.build.dir" location="${build.dir}/docs"/>
+        <mkdir dir="${release.docs.build.dir}"/>
+
+        <!-- generate the Beehive documentation -->
+        <ant antfile="build.xml" target="docs" inheritAll="false"/>    
+
+        <!-- copy Beehive API Javadoc together to the top-level docs directory -->
+        <copy todir="${release.docs.build.dir}/apidocs" failOnError="true">
+            <fileset dir="controls/build/docs/apidocs"/>
+            <fileset dir="netui/build/docs/apidocs"/>
+            <fileset dir="wsm/build/docs/apidocs"/>
+            <fileset dir="system-controls/build/docs/apidocs"/>
+        </copy>
+        
+        <copy todir="${release.docs.build.dir}" failOnError="true">
+            <fileset dir="docs/forrest/release/build/site"/>
+        </copy>
     </target>		
 
     <!-- Took off the long depends list so this can be called in a chain without reinvoking all the targets it depends on.
@@ -477,7 +489,6 @@
     <!-- Docs Distribution Archives                    -->
     <!--                                               -->
     <!-- ============================================= -->
-
     <target name="build.dist.docs.zip" description="Builds a Beehive distribution docs zipfile">
         <fail unless="beehive.version" message="Could not build distribution archive; beehive.version was not specified"/>