You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oro-dev@jakarta.apache.org by df...@apache.org on 2003/06/03 19:17:24 UTC

cvs commit: jakarta-oro build.xml

dfs         2003/06/03 10:17:24

  Modified:    .        build.xml
  Log:
  Added descriptions to each target.
  
  Revision  Changes    Path
  1.5       +35 -30    jakarta-oro/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-oro/build.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- build.xml	26 Jan 2003 02:26:53 -0000	1.4
  +++ build.xml	3 Jun 2003 17:17:24 -0000	1.5
  @@ -20,7 +20,6 @@
     clean          removes generated files
     docs           builds xml documentation
     examples       builds the example programs
  -  awk-examples   builds the awk example programs
     jar            builds lib + jar
     javadocs       builds the javadoc
     lib            builds the library
  @@ -29,6 +28,8 @@
     package-tgz    builds a tarred and gzipped distribution
     package-zip    builds a zipped distribution
     tools          builds the tools
  +
  +Run ant -projecthelp for complete list of targets with descriptions.
   -->
   
   <project default="jar">
  @@ -43,9 +44,10 @@
     <property file="default.properties"/>  
    -->
   
  -    <!-- prepare target.  Creates build directory. -->
  +    <!-- prepare target.  Creates build directories. -->
   
  -    <target name="prepare">
  +    <target name="prepare"
  +            description="Creates build directories.">
          <tstamp>
            <format property="DATE" pattern="yyyy-MM-dd hh:mm:ss" />
          </tstamp>
  @@ -63,7 +65,8 @@
       </target>
   
       <target name="prepare-error" depends="prepare"
  -     unless="AnakiaTask.present">
  +            description="Prints error message for prepare target."
  +	    unless="AnakiaTask.present">
          <echo>
           AnakiaTask is not present! Please check to make sure that 
           velocity.jar is in your classpath.
  @@ -72,7 +75,8 @@
   
       <!-- lib target.  Compiles the library classes only -->
   
  -    <target name="lib" depends="prepare">
  +    <target name="lib" depends="prepare"
  +            description="Compiles the library classes only.">
           <javac srcdir="${build.src}"
               destdir="${build.dest}"
               excludes="examples/**,tools/**"
  @@ -83,20 +87,11 @@
   
       <!-- examples target.  Compiles the example classes. -->
   
  -    <target name="examples" depends="prepare,lib">
  -        <javac srcdir="${build.src}/examples"
  -        excludes="awk/**"
  -            destdir="${build.dest}"
  -            debug="${debug}"
  -            deprecation="${deprecation}"
  -            optimize="${optimize}"/>
  -    </target>
  -
  -    <!-- awk-examples target.  Compiles the example classes. -->
  -
  -    <target name="examples-awk" depends="prepare,lib">
  -        <javac srcdir="${build.src}/examples/awk"
  +    <target name="examples" depends="prepare,lib"
  +            description="Compiles the example classes.">
  +        <javac srcdir="${build.src}"
               destdir="${build.dest}"
  +            includes="examples/**"
               debug="${debug}"
               deprecation="${deprecation}"
               optimize="${optimize}"/>
  @@ -104,9 +99,11 @@
   
       <!-- tools target.  Compiles the tool classes. -->
   
  -    <target name="tools" depends="prepare,lib">
  -        <javac srcdir="${build.src}/tools"
  +    <target name="tools" depends="prepare,lib"
  +            description="Compiles the tool classes.">
  +        <javac srcdir="${build.src}"
               destdir="${build.dest}"
  +            includes="tools/**"
               debug="${debug}"
               deprecation="${deprecation}"
               optimize="${optimize}"/>
  @@ -114,7 +111,8 @@
       
       <!-- tests target.  Compiles and runs the unit tests. -->
   
  -    <target name="tests" depends="prepare,lib">
  +    <target name="tests" depends="prepare,lib"
  +            description="Compiles and runs the unit tests.">
           <javac srcdir="${build.src}/tests"
               destdir="${build.tests}"
               debug="${debug}"
  @@ -124,7 +122,8 @@
   
       <!-- jar target.  Compiles the source directory and creates a .jar file -->
   
  -    <target name="jar" depends="lib">
  +    <target name="jar" depends="lib"
  +          description="Compiles the source directory and creates a .jar file.">
           <jar jarfile="${top.dir}/${final.name}.jar"
               basedir="${build.dest}"
               includes="org/**,META-INF/**"
  @@ -150,7 +149,8 @@
   
       <!-- javadocs target.  Creates the API documentation -->
   
  -    <target name="javadocs" depends="prepare">
  +    <target name="javadocs" depends="prepare"
  +            description="Creates the API documentation.">
           <mkdir dir="${javadoc.destdir}"/>
           <javadoc packagenames="org.apache.oro.io,org.apache.oro.text,org.apache.oro.text.regex,org.apache.oro.text.awk,org.apache.oro.text.perl,org.apache.oro.util"
               sourcepath="${build.src}"
  @@ -171,8 +171,9 @@
   
       <!-- docs target.  Creates project web pages and documentation. -->
       <target name="docs" depends="prepare-error,lib,examples"
  -        if="AnakiaTask.present">
  -        <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask">
  +          description="Creates the project web pages and documentation."
  +	  if="AnakiaTask.present">
  +      <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask">
             <classpath>
               <fileset dir="${jakarta-site2.dir}/lib">
                 <include name="*.jar"/>
  @@ -213,7 +214,8 @@
   
       <!-- package target -->
   
  -    <target name="package" depends="jar,javadocs,docs">
  +    <target name="package" depends="jar,javadocs,docs"
  +            description="Creates a distribution directory tree.">
           <mkdir dir="${final.dir}"/>
           <copy todir="${final.dir}/src">
               <fileset dir="${code.src}"/>
  @@ -245,14 +247,16 @@
   
       <!-- package-zip target.  Packages the distribution with ZIP -->
   
  -    <target name="package-zip" depends="package">
  +    <target name="package-zip" depends="package"
  +            description="Packages the distribution as a zip file.">
           <zip zipfile="${top.dir}/${final.name}.zip" basedir="${top.dir}/"
                includes="**/${final.name}/**" excludes="**/.cvsignore"/>
       </target>
       
       <!-- Packages the distribution with TAR-GZIP -->
   
  -    <target name="package-tgz" depends="package">
  +    <target name="package-tgz" depends="package"
  +            description="Packages the distribution as a gzipped tar file.">
           <tar tarfile="${top.dir}/${final.name}.tar"
                basedir="${top.dir}" excludes="**/**">
             <tarfileset dir="${final.dir}/..">
  @@ -270,7 +274,8 @@
   
       <!-- Makes an attempt to clean up a little. -->
   
  -    <target name="clean">
  +    <target name="clean"
  +	    description="Removes generated artifacts from source tree.">
           <delete dir="${build.dest}"/>
           <delete dir="${javadoc.destdir}"/>
           <delete dir="${final.dir}"/>
  
  
  

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