Return-Path: 
 <cocoon-dev-return-12407-apmail-xml-cocoon-dev-archive=xml.apache.org@xml.apache.org>
Delivered-To: apmail-xml-cocoon-dev-archive@xml.apache.org
Received: (qmail 47526 invoked by uid 500); 13 Apr 2001 10:34:39 -0000
Mailing-List: contact cocoon-dev-help@xml.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:cocoon-dev-help@xml.apache.org>
list-unsubscribe: <mailto:cocoon-dev-unsubscribe@xml.apache.org>
list-post: <mailto:cocoon-dev@xml.apache.org>
Reply-To: cocoon-dev@xml.apache.org
Delivered-To: mailing list cocoon-dev@xml.apache.org
Received: (qmail 47296 invoked from network); 13 Apr 2001 10:34:29 -0000
Date: Fri, 13 Apr 2001 21:32:29 +1000
From: Jeff Turner <jeff@socialchange.net.au>
To: cocoon-dev@xml.apache.org
Subject: [C1][PATCH] using <uptodate> in build.xml
Message-ID: <20010413213228.A7825@socialchange.net.au>
Mail-Followup-To: cocoon-dev@xml.apache.org
Mime-Version: 1.0
Content-Type: multipart/mixed; boundary="qDbXVdCdHGoSgWSk"
Content-Disposition: inline
User-Agent: Mutt/1.3.15i
X-Spam-Rating: h31.sny.collab.net 1.6.2 0/1000/N

--qDbXVdCdHGoSgWSk
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Hi,

Attached is a patch for C1 build.xml, which utilizes the Ant1.3 <uptodate>
task to shortcut the "javadocs", "docs" and "printer-docs" targets if
their source files have not changed.

This patch takes into account the slightly weird preparation step, where
todo.xml and changes.xml are copied, and book.xml overwritten.

If it is determined that the target is up-to-date, then a message is
printed, eg:

init:
     [echo]       ------------------- Cocoon 1.8.3-dev [1999-2001] ---------

prepare-docs:
   [delete] Deleting: /home/jeff/apache/xml/xml-cocoon/xdocs/book.xml
     [copy] Copying 1 file to /home/jeff/apache/xml/xml-cocoon/xdocs

docs_check:

docs_done:
     [echo] -------------------------------------------------------------
     [echo] Not rebuilding docs, as they are up-to-date:
     [echo]   ./build/docs/index.html is more recent than
     [echo]   todo.xml, changes.xml, non-generated ./xdocs/*.xml
     [echo] -------------------------------------------------------------

docs:

BUILD SUCCESSFUL


If this is deemed useful, I can create a similar patch to C2 build.xml.

--Jeff

--qDbXVdCdHGoSgWSk
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="build.xml.patch"

Index: build.xml
===================================================================
RCS file: /home/cvspublic/xml-cocoon/build.xml,v
retrieving revision 1.71
diff -u -r1.71 build.xml
--- build.xml	2001/03/26 17:47:55	1.71
+++ build.xml	2001/04/13 10:28:12
@@ -159,6 +159,8 @@
 
     <property name="browser.skin" value="${skins.dir}/xml.apache.org/"/>
     <property name="printer.skin" value="${skins.dir}/printer/"/>
+    <property name="browser.projfile" value="docs-book.xml"/>
+    <property name="site.projfile" value="site-book.xml"/>
     <property name="doc.generator" value="org.apache.stylebook.StyleBook"/>
     <property name="doc.generator.package" value="${lib.dir}/stylebook-1.0-b2.jar"/>
 
@@ -286,9 +288,9 @@
            deprecation="${deprecation}"/>
     <copy todir="${build.dest}" filtering="on">
       <fileset dir="${src.dir}">
-	    <include name="**/*.xsl"/>
-	  </fileset>
-	</copy>
+        <include name="**/*.xsl"/>
+      </fileset>
+    </copy>
   </target>
 
   <!-- =================================================================== -->
@@ -313,13 +315,34 @@
     <replace file="${docs.dir}/todo.xml" token="./xdocs/dtd/" value="dtd/"/>
 
     <delete file="${docs.dir}/book.xml"/>
-    <copy file="${docs.dir}/docs-book.xml" tofile="${docs.dir}/book.xml" filtering="on"/>
+    <copy file="${docs.dir}/${browser.projfile}" tofile="${docs.dir}/book.xml" filtering="on"/>
   </target>
 
   <!-- =================================================================== -->
+  <!-- Set a variable if the generated docs are already up-to-date.        -->
+  <!-- =================================================================== -->
+  <target name="docs_check" depends="init">
+    <uptodate property="docs.notrequired" targetfile="${build.docs}/index.html">
+      <srcfiles dir="." includes="changes.xml,todo.xml"/>
+      <srcfiles dir="${docs.dir}" includes="*.xml" excludes="changes.xml,todo.xml,book.xml,${site.projfile}"/>
+    </uptodate>
+  </target>
+ 
+  <!-- =================================================================== -->
+  <!-- If generated docs are already up-to-date, print a message saying so. -->
+  <!-- =================================================================== -->
+  <target name="docs_done" if="docs.notrequired">
+    <echo message="-------------------------------------------------------------"/>
+    <echo message="Not rebuilding docs, as they are up-to-date:"/>
+    <echo message="  ${build.docs}/index.html is more recent than"/>
+    <echo message="  todo.xml, changes.xml, non-generated ${docs.dir}/*.xml"/>
+    <echo message="-------------------------------------------------------------"/>
+  </target>
+
+  <!-- =================================================================== -->
   <!-- Generate HTML docs                                                  -->
   <!-- =================================================================== -->
-  <target name="docs" depends="prepare-docs">
+  <target name="docs" depends="prepare-docs, docs_check, docs_done" unless="docs.notrequired">
     <mkdir dir="${build.docs}"/>
     <java fork="yes" classpath="${java.class.path}:${doc.generator.package}" 
      classname="${doc.generator}">
@@ -328,9 +351,30 @@
   </target>
 
   <!-- =================================================================== -->
+  <!-- Set a variable if the generated printer docs are already up-to-date. -->
+  <!-- =================================================================== -->
+  <target name="printer-docs_check" depends="init">
+    <uptodate property="printer-docs.notrequired" targetfile="${build.docs.printer}/index.html" >
+      <srcfiles dir="." includes="changes.xml,todo.xml"/>
+      <srcfiles dir="${docs.dir}" includes="*.xml" excludes="changes.xml,todo.xml,book.xml,${site.projfile}"/>
+    </uptodate>
+  </target>
+ 
+  <!-- =================================================================== -->
+  <!-- If generated printer docs are already up-to-date, print a message saying so. -->
+  <!-- =================================================================== -->
+  <target name="printer-docs_done" if="printer-docs.notrequired">
+    <echo message="-------------------------------------------------------------"/>
+    <echo message="Not rebuilding printer docs, as they are up-to-date:"/>
+    <echo message="  ${build.docs.printer}/index.html is more recent than"/>
+    <echo message="  todo.xml, changes.xml, non-generated ${docs.dir}/*.xml"/>
+    <echo message="-------------------------------------------------------------"/>
+  </target>
+
+  <!-- =================================================================== -->
   <!-- Generate printer-friendly HTML docs                                 -->
   <!-- =================================================================== -->
-  <target name="printer-docs" depends="prepare-docs">
+  <target name="printer-docs" depends="prepare-docs, printer-docs_check, printer-docs_done" unless="printer-docs.notrequired">
     <mkdir dir="${build.docs.printer}"/>
     <java fork="yes" classpath="${java.class.path}:${doc.generator.package}" 
      classname="${doc.generator}">
@@ -339,12 +383,33 @@
   </target>
 
   <!-- =================================================================== -->
+  <!-- Set a variable if the generated site is already up-to-date.         -->
+  <!-- =================================================================== -->
+  <target name="site_check" depends="init">
+    <uptodate property="site.notrequired" targetfile="${site}/index.html" >
+      <srcfiles dir="." includes="changes.xml,todo.xml,${browser.projfile}"/>
+      <srcfiles dir="${docs.dir}" includes="*.xml" excludes="changes.xml,todo.xml,book.xml,${browser.projfile}"/>
+    </uptodate>
+  </target>
+ 
+  <!-- =================================================================== -->
+  <!-- If generated site is already up-to-date, print a message saying so. -->
+  <!-- =================================================================== -->
+  <target name="site_done" if="site.notrequired">
+    <echo message="-------------------------------------------------------------"/>
+    <echo message="Not rebuilding site, as it is up-to-date:"/>
+    <echo message="  ${site}/index.html is more recent than"/>
+    <echo message="  todo.xml, changes.xml, non-generated ${docs.dir}/*.xml"/>
+    <echo message="-------------------------------------------------------------"/>
+  </target>
+
+  <!-- =================================================================== -->
   <!-- Creates the web site                                                -->
   <!-- =================================================================== -->
-  <target name="site" depends="prepare-docs">
+  <target name="site" depends="prepare-docs, site_check, site_done" unless="site.notrequired">
     <mkdir dir="${site}"/>
     <delete file="${docs.dir}/book.xml"/>
-    <copy file="${docs.dir}/site-book.xml" tofile="${docs.dir}/book.xml" filtering="on"/>
+    <copy file="${docs.dir}/${site.projfile}" tofile="${docs.dir}/book.xml" filtering="on"/>
     <java fork="yes" classpath="${java.class.path}:${doc.generator.package}"
      classname="${doc.generator}">
       <arg line="targetDirectory=${site} ${docs.dir}/book.xml ${browser.skin}"/>
@@ -352,9 +417,29 @@
   </target>
 
   <!-- =================================================================== -->
+  <!-- Set a variable if javadoc is already up-to-date.                    -->
+  <!-- =================================================================== -->
+  <target name="javadocs_check">
+    <uptodate property="javadocs.notrequired" targetfile="${build.javadocs}/packages.html" >
+      <srcfiles dir= "${build.src}" includes="**/*.java"/>
+    </uptodate>
+  </target>
+  
+  <!-- =================================================================== -->
+  <!-- If javadoc is already up-to-date, print a message saying so.        -->
+  <!-- =================================================================== -->
+  <target name="javadocs_done" if="javadocs.notrequired">
+    <echo message="-------------------------------------------------------------"/>
+    <echo message="Not rebuilding Javadocs, as they are up-to-date:"/>
+    <echo message="  ${build.javadocs}/packages.html is more recent than"/>
+    <echo message="  ${build.src}/**/*.java"/>
+    <echo message="-------------------------------------------------------------"/>
+  </target>
+
+  <!-- =================================================================== -->
   <!-- Creates the API documentation                                       -->
   <!-- =================================================================== -->
-  <target name="javadocs" depends="prepare-src">
+  <target name="javadocs" depends="prepare-src, javadocs_check, javadocs_done" unless="javadocs.notrequired">
     <mkdir dir="${build.javadocs}"/>
     <javadoc packagenames="${packages}"
              sourcepath="${build.src}"


--qDbXVdCdHGoSgWSk
Content-Type: text/plain; charset=us-ascii

---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org
--qDbXVdCdHGoSgWSk--