hivemind-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hls...@apache.org
Subject cvs commit: jakarta-hivemind/examples build.xml
Date Thu, 21 Oct 2004 14:57:19 GMT
hlship      2004/10/21 07:57:19

  Modified:    hivebuild/report-artifacts license-report.trailer.xml
                        license-report.header.xml
               hivebuild/hivedoc-xsl hivemind.css
               hivebuild license-report.xml javadoc-report.xml javacc.xml
                        hivedoc-report.properties project.xml
                        hivebuild.properties hivedoc-report.xml
               .        build.xml status.xml forrest.properties
               src/documentation/conf cli.xconf
               examples build.xml
  Log:
  Re-work the HiveDoc report to work naturally at the module (not project) level.
  
  Revision  Changes    Path
  1.2       +0 -1      jakarta-hivemind/hivebuild/report-artifacts/license-report.trailer.xml
  
  Index: license-report.trailer.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/report-artifacts/license-report.trailer.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- license-report.trailer.xml	11 Jul 2004 17:14:43 -0000	1.1
  +++ license-report.trailer.xml	21 Oct 2004 14:57:19 -0000	1.2
  @@ -1,7 +1,6 @@
   	
   ]]>
   </source>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  
  
  
  1.3       +0 -1      jakarta-hivemind/hivebuild/report-artifacts/license-report.header.xml
  
  Index: license-report.header.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/report-artifacts/license-report.header.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- license-report.header.xml	21 Oct 2004 12:35:57 -0000	1.2
  +++ license-report.header.xml	21 Oct 2004 14:57:19 -0000	1.3
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  
  
  
  1.3       +1 -2      jakarta-hivemind/hivebuild/hivedoc-xsl/hivemind.css
  
  Index: hivemind.css
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/hivedoc-xsl/hivemind.css,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- hivemind.css	26 Sep 2004 15:08:19 -0000	1.2
  +++ hivemind.css	21 Oct 2004 14:57:19 -0000	1.3
  @@ -1,5 +1,4 @@
  -/* $Id$
  - *
  +/* 
    * Copyright 2004 The Apache Software Foundation
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
  
  
  
  1.3       +0 -1      jakarta-hivemind/hivebuild/license-report.xml
  
  Index: license-report.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/license-report.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- license-report.xml	21 Oct 2004 12:35:56 -0000	1.2
  +++ license-report.xml	21 Oct 2004 14:57:19 -0000	1.3
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  
  
  
  1.3       +0 -1      jakarta-hivemind/hivebuild/javadoc-report.xml
  
  Index: javadoc-report.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/javadoc-report.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- javadoc-report.xml	21 Oct 2004 12:35:56 -0000	1.2
  +++ javadoc-report.xml	21 Oct 2004 14:57:19 -0000	1.3
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  
  
  
  1.3       +0 -1      jakarta-hivemind/hivebuild/javacc.xml
  
  Index: javacc.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/javacc.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- javacc.xml	28 Jul 2004 19:19:35 -0000	1.2
  +++ javacc.xml	21 Oct 2004 14:57:19 -0000	1.3
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  
  
  
  1.3       +3 -3      jakarta-hivemind/hivebuild/hivedoc-report.properties
  
  Index: hivedoc-report.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/hivedoc-report.properties,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- hivedoc-report.properties	18 Jul 2004 22:40:23 -0000	1.2
  +++ hivedoc-report.properties	21 Oct 2004 14:57:19 -0000	1.3
  @@ -26,7 +26,7 @@
   # The XSLT file that generates most of the documentation.
   hivedoc.xslt.file=${hivedoc.assets.dir}/hivemind.xsl
   
  -# Directory to which HiveDoc should be generated. It assumes that HiveDoc
  -# is generated at the project level.
  +# Default directory to which HiveDoc should be generated. This is useful for
  +# the normal case ... hivedocs generated for a module (not a project).
   
  -hivedoc.output.dir=${project.docs.target.dir}/hivedocs
  +hivedoc.output.dir=${module.docs.target.dir}/hivedocs
  
  
  
  1.5       +1 -2      jakarta-hivemind/hivebuild/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/project.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- project.xml	21 Oct 2004 12:35:56 -0000	1.4
  +++ project.xml	21 Oct 2004 14:57:19 -0000	1.5
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  @@ -67,7 +66,7 @@
   		<target name="site" description="Build site documentation using Forrest.">
   		
   			<unpacked-zip-dependency
  -					url="http://www.apache.org/dist/forrest/"
  +					url="${apache.mirror.url}/forrest/"
   					zip="apache-forrest-0.6.zip"
   					dir="${forrest-package-dir}"/>
   			
  
  
  
  1.3       +5 -0      jakarta-hivemind/hivebuild/hivebuild.properties
  
  Index: hivebuild.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/hivebuild.properties,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- hivebuild.properties	20 Jul 2004 17:27:07 -0000	1.2
  +++ hivebuild.properties	21 Oct 2004 14:57:19 -0000	1.3
  @@ -124,3 +124,8 @@
   
   forrest.report-artifacts.dir=${hivebuild.dir}/report-artifacts
   
  +# Base URL for accessing files distributed via the Apache mirror server
  +# network. This can be overridden on the command line when another
  +# server is preferred.
  +
  +apache.mirror.url=http://www.ibiblio.org/pub/mirrors/apache
  \ No newline at end of file
  
  
  
  1.5       +22 -17    jakarta-hivemind/hivebuild/hivedoc-report.xml
  
  Index: hivedoc-report.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/hivebuild/hivedoc-report.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- hivedoc-report.xml	21 Oct 2004 12:35:56 -0000	1.4
  +++ hivedoc-report.xml	21 Oct 2004 14:57:19 -0000	1.5
  @@ -1,5 +1,4 @@
   <?xml version="1.0"?>
  -<!-- $Id$ -->
   <!-- 
      Copyright 2004 The Apache Software Foundation
   
  @@ -19,25 +18,32 @@
   	<fail unless="ant.file.forrestdoc" message="Must import forrestdoc.xml first."/>
   	<property file="${hivebuild.dir}/hivedoc-report.properties"/>
   	
  -	<!-- Fileset used to identify the derived files that will be scanned for
  -		   module deployment descriptors. -->
  +	<!-- It is expected that the master hivemind JAR, and its dependencies,
  +       are dependencies of this module. -->
   		   
  -	<path id="default.hivedoc.classpath">
  -		<fileset dir="${target.dir}">
  -			<include name="*.jar"/>
  -		</fileset>
  -		<fileset dir="${external.lib.dir}">
  -			<include name="**/*.jar"/>
  -		</fileset>
  +	<path id="default.hivedoc.taskdef.classpath">
  +    <fileset dir="${module.lib.dir}" includes="**/*.jar"/>
   	</path>
  +  
  +  <!-- Defines the JARs and descriptors from which the report will be generated. -->
  +  
  +  <path id="default.hivedoc.classpath">
  +    <path refid="default.hivedoc.taskdef.classpath"/>
  +    
  +    <!-- The Ant task will process includes in the hivemodule.xml. -->
  +    <fileset dir="${descriptor.src.dir}" includes="**/hivemodule.xml"/>
  +  </path>
   	
   	
   	<macrodef name="hivedoc-report">
   		<attribute name="doc-path-id" default="default.hivedoc.classpath"
   				description="Path defining the files to obtain deployment descriptors from."/>
   						
  -		<attribute name="taskdef-path-id" default="default.hivedoc.classpath"
  +		<attribute name="taskdef-path-id" default="default.hivedoc.taskdef.classpath"
   				description="Path containing the master HiveMind module, which contains the Ant tasks."/>
  +        
  +    <attribute name="output-dir" default="${hivedoc.output.dir}"
  +        description="Directory to which output should be generated."/>
   				
   		<sequential>
   			<announce message="Building Master Registry ..."/>
  @@ -53,22 +59,21 @@
   				<descriptors refid="@{doc-path-id}"/>	
   			</constructregistry>
   
  -			<mkdir dir="${hivedoc.output.dir}"/>
  +			<mkdir dir="@{output-dir}"/>
   			
   			<announce message="Building HiveDoc ..."/>
   			
  -			<xslt out="${hivedoc.output.dir}/index.html"
  +			<xslt out="@{output-dir}/index.html"
   				in="${hivedoc.registry.file}"
   				style="${hivedoc.xslt.file}">
  -				<param name="base.dir" expression="${hivedoc.output.dir}"/>
  +				<param name="base.dir" expression="@{output-dir}"/>
   			</xslt>
   				
  -			<copy todir="${hivedoc.output.dir}">
  +			<copy todir="@{output-dir}">
   				<fileset dir="${hivedoc.assets.dir}">
   					<exclude name="*.xsl"/>	
   				</fileset>	
  -			</copy>
  -				
  +			</copy>				
   
   			<add-report-to-menu element="hivedoc-report" label="HiveDoc"
   				file="hivedocs/index.html"/>
  
  
  
  1.10      +15 -1     jakarta-hivemind/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/build.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- build.xml	20 Jul 2004 17:27:16 -0000	1.9
  +++ build.xml	21 Oct 2004 14:57:19 -0000	1.10
  @@ -26,12 +26,26 @@
   	<import file="hivebuild/project.xml"/>
     
   	<import file="${hivebuild.dir}/license-report.xml"/>
  +  
  +  <!-- Generating HiveDoc at the top level is unusual, and requires the use of non-default
paths.
  +       In this case, we know that the generated JAR files contain both the Ant task and
the desired
  +       descriptors.  -->
  +  
  +  <path id="hivedoc.classpath">
  +    <fileset dir="${target.dir}" includes="*.jar"/>
  +    <!-- Pick up some hivemind dependencies -->
  +    <fileset dir="${external.lib.dir}" includes="**/*.jar"/>
  +  </path>  
  +  
   	<import file="${hivebuild.dir}/hivedoc-report.xml"/>
   	<import file="${hivebuild.dir}/dist.xml"/>
   
   	<target name="run-reports">
   		<license-report/>
  -		<hivedoc-report/>
  +		<hivedoc-report
  +        doc-path-id="hivedoc.classpath" 
  +        taskdef-path-id="hivedoc.classpath" 
  +        output-dir="${project.docs.target.dir}/hivedocs"/>
   	</target>
   	
   	<target name="fast-site" depends="copy-documentation-to-composite"
  
  
  
  1.68      +6 -0      jakarta-hivemind/status.xml
  
  Index: status.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/status.xml,v
  retrieving revision 1.67
  retrieving revision 1.68
  diff -u -r1.67 -r1.68
  --- status.xml	14 Oct 2004 14:31:34 -0000	1.67
  +++ status.xml	21 Oct 2004 14:57:19 -0000	1.68
  @@ -50,6 +50,12 @@
           HiveDoc is now being generated from the parsed module descriptors instead of directly
from
           the XML files.  This will allow HiveDoc generation for module descriptors in other
formats.
         </action>
  +      <action type="update" dev="HLS">
  +        Upgrade to Forrest 0.6 (still in progress).
  +      </action>
  +      <action type="update" dev="HLS">
  +        Re-work the HiveDoc report to work naturally at the module (not project) level.
  +      </action>
       </release>
   
      <release version="1.0" date="Sep 22 2004">
  
  
  
  1.4       +3 -1      jakarta-hivemind/forrest.properties
  
  Index: forrest.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/forrest.properties,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- forrest.properties	21 Oct 2004 12:35:56 -0000	1.3
  +++ forrest.properties	21 Oct 2004 14:57:19 -0000	1.4
  @@ -23,4 +23,6 @@
   project.debuglevel=DEBUG
   project.bugtracking-url=http://nagoya.apache.org/jira/browse/
   
  -project.skin=pelt
  \ No newline at end of file
  +project.skin=pelt
  +
  +project.configfile=${project.home}/src/documentation/conf/cli.xconf
  \ No newline at end of file
  
  
  
  1.5       +7 -4      jakarta-hivemind/src/documentation/conf/cli.xconf
  
  Index: cli.xconf
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/src/documentation/conf/cli.xconf,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- cli.xconf	21 Oct 2004 12:35:57 -0000	1.4
  +++ cli.xconf	21 Oct 2004 14:57:19 -0000	1.5
  @@ -207,12 +207,15 @@
      <exclude pattern="**/hivedocs/**"/>
      <exclude pattern="**/apidocs/**"/>
      <exclude pattern="**/clover/**"/>
  +   
  +   <!-- Cocoon keeps ignoring the content file and tries to build it from an xml file
  +        for some reason. -->
  +        
  +   <exclude pattern="**/HiveMind-QuickReference.doc"/>
   
      <!-- Exclude tokens used in URLs to ASF mirrors (interpreted by a CGI) -->
      <exclude pattern="[preferred]/**"/>
      <exclude pattern="[location]"/>
  -   
  -   <uri src="favicon.ico"/>
   
      
      <!--   <include-links extension=".html"/>-->
  @@ -297,9 +300,9 @@
          | used to manage multiple sites.
          +-->
   
  -   <uris name="mirrors" follow-links="false">
  +   <!-- uris name="mirrors" follow-links="false">
        <uri type="append" src="mirrors.html"/>
  -   </uris>
  +   </uris -->
   
      <!--+
          |  File containing URIs (plain text, one per line).
  
  
  
  1.9       +3 -11     jakarta-hivemind/examples/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-hivemind/examples/build.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- build.xml	16 Aug 2004 14:42:26 -0000	1.8
  +++ build.xml	21 Oct 2004 14:57:19 -0000	1.9
  @@ -22,15 +22,10 @@
     <import file="${root.dir}/hivebuild/jar-module.xml"/>
     <import file="${hivebuild.dir}/javadoc-report.xml"/>
     <import file="${hivebuild.dir}/clover-report.xml"/>
  -  <!-- HiveDoc report is normally setup for project level, but we're using it
  -	     at the module level, so we need to tweak. -->
  -  <path id="hivedoc.taskdef.classpath">
  -    <fileset dir="${module.lib.dir}" includes="**/*.jar"/>
  -    <pathelement location="${conf.src.dir}"/>
  -  </path>
  +  <import file="${hivebuild.dir}/hivedoc-report.xml"/>  
     
     <path id="hivedoc.classpath">
  -    <path refid="hivedoc.taskdef.classpath"/>
  +    <path refid="default.hivedoc.classpath"/>
       <fileset dir="${descriptor.src.dir}/META-INF">
         <include name="panorama.xml"/>
         <include name="examples.xml"/>
  @@ -52,9 +47,6 @@
        <fileset dir="${ant.home}/lib" includes="*.jar"/>
     </path>
     
  -  <property name="hivedoc.output.dir" location="${module.docs.target.dir}/hivedocs"/>
  -  <import file="${hivebuild.dir}/hivedoc-report.xml"/>
  -  
     <target name="compile">
       <ibiblio-dependency artifact="geronimo-spec-ejb" version="1.0-M1" group="geronimo-spec"/>
       <ibiblio-dependency artifact="spring-full" version="1.0.1" group="springframework"/>
  @@ -71,7 +63,7 @@
     
     <target name="run-reports">
       <javadoc-report/>
  -    <hivedoc-report doc-path-id="hivedoc.classpath" taskdef-path-id="hivedoc.taskdef.classpath"/>
  +    <hivedoc-report doc-path-id="hivedoc.classpath"/>
       <clover-report/>
     </target>
     
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: hivemind-cvs-unsubscribe@jakarta.apache.org
For additional commands, e-mail: hivemind-cvs-help@jakarta.apache.org


Mime
View raw message