From a68ae35518ba37fad51b52e2eb006b7d3b80b094 Mon Sep 17 00:00:00 2001 From: Peter Reilly Date: Fri, 11 Mar 2005 09:42:56 +0000 Subject: [PATCH] minor mods to examples, + add some headers to tables git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277892 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/OptionalTasks/attrib.html | 4 +-- docs/manual/OptionalTasks/chgrp.html | 5 ++-- docs/manual/OptionalTasks/chown.html | 33 ++++++++++++----------- docs/manual/OptionalTasks/dotnet.html | 4 +++ docs/manual/OptionalTasks/ejb.html | 31 ++++++++++++--------- docs/manual/OptionalTasks/ftp.html | 12 +++------ docs/manual/OptionalTasks/icontract.html | 3 +-- docs/manual/OptionalTasks/jpcoverage.html | 32 +++++++++++++--------- docs/manual/OptionalTasks/jspc.html | 1 - docs/manual/OptionalTasks/perforce.html | 4 +++ 10 files changed, 73 insertions(+), 56 deletions(-) diff --git a/docs/manual/OptionalTasks/attrib.html b/docs/manual/OptionalTasks/attrib.html index 68cd9001c..79235ac11 100644 --- a/docs/manual/OptionalTasks/attrib.html +++ b/docs/manual/OptionalTasks/attrib.html @@ -72,8 +72,8 @@ nested <fileset>, <dirset> and

Examples

-
-

<attrib file="${dist}/run.bat" readonly="true" hidden="true"/>

+
+
<attrib file="${dist}/run.bat" readonly="true" hidden="true"/>

makes the "run.bat" file read-only and hidden.

diff --git a/docs/manual/OptionalTasks/chgrp.html b/docs/manual/OptionalTasks/chgrp.html index a4d5cb605..ecfd2072c 100644 --- a/docs/manual/OptionalTasks/chgrp.html +++ b/docs/manual/OptionalTasks/chgrp.html @@ -77,8 +77,9 @@ nested <fileset>, <dirset> and

Examples

-
-

<chgrp file="${dist}/start.sh" group="coders"/>

+
+<chgrp file="${dist}/start.sh" group="coders"/>
+

makes the "start.sh" file belong to the coders group on a UNIX system.

diff --git a/docs/manual/OptionalTasks/chown.html b/docs/manual/OptionalTasks/chown.html index dcacd8e57..481b4dfb4 100644 --- a/docs/manual/OptionalTasks/chown.html +++ b/docs/manual/OptionalTasks/chown.html @@ -77,27 +77,28 @@ nested <fileset>, <dirset> and

Examples

-
-

<chown file="${dist}/start.sh" owner="coderjoe"/>

+
+<chown file="${dist}/start.sh" owner="coderjoe"/>
+
-

makes the "start.sh" file belong to coderjoe on a +

makes the "start.sh" file belong to coderjoe on a UNIX system.

-    <chown owner="coderjoe">
-      <fileset dir="${dist}/bin" includes="**/*.sh"/>
+    <chown owner="coderjoe">
+      <fileset dir="${dist}/bin" includes="**/*.sh"/>
     </chown>
 
-

makes all ".sh" files below ${dist}/bin +

makes all ".sh" files below ${dist}/bin belong to coderjoe on a UNIX system.

-<chown owner="coderjoe">
-  <fileset dir="shared/sources1">
-    <exclude name="**/trial/**"/>
+<chown owner="coderjoe">
+  <fileset dir="shared/sources1">
+    <exclude name="**/trial/**"/>
   </fileset>
-  <fileset refid="other.shared.sources"/>
+  <fileset refid="other.shared.sources"/>
 </chown>
 
@@ -109,13 +110,13 @@ owner.

-<chown owner="webadmin" type="file">
-  <fileset dir="/web">
-    <include name="**/*.cgi"/>
-    <include name="**/*.old"/>
+<chown owner="webadmin" type="file">
+  <fileset dir="/web">
+    <include name="**/*.cgi"/>
+    <include name="**/*.old"/>
   </fileset>
-  <dirset dir="/web">
-    <include name="**/private_*"/>
+  <dirset dir="/web">
+    <include name="**/private_*"/>
   </dirset>
 </chmod>
 
diff --git a/docs/manual/OptionalTasks/dotnet.html b/docs/manual/OptionalTasks/dotnet.html index 2a302f53f..7767b5611 100644 --- a/docs/manual/OptionalTasks/dotnet.html +++ b/docs/manual/OptionalTasks/dotnet.html @@ -64,6 +64,10 @@ can, however, be done if absolutely necessary.

Task List

+ + + + diff --git a/docs/manual/OptionalTasks/ejb.html b/docs/manual/OptionalTasks/ejb.html index a3e12d517..abd3d0a23 100644 --- a/docs/manual/OptionalTasks/ejb.html +++ b/docs/manual/OptionalTasks/ejb.html @@ -107,7 +107,8 @@ is based on the standard Ant include and exclude selection mechanisms.
TaskDescription
Csc Compiles C# code

Examples

-
<ddcreator descriptors="${dd.dir}"
+
+<ddcreator descriptors="${dd.dir}"
            dest="${gen.classes}"
            classpath="${descriptorbuild.classpath}">
   <include name="*.txt"/>
@@ -177,7 +178,8 @@ or are out of date, the ejbc tool is run to generate new versions.

Examples

-
<ejbc descriptors="${gen.classes}"
+
+<ejbc descriptors="${gen.classes}"
            src="${src.dir}"
            dest="${gen.classes}"
            manifest="${build.manifest}"
@@ -291,7 +293,8 @@ directory. If omitted, the ejbc utility must be on the user's system path. 
 

Examples

-
<iplanet-ejbc ejbdescriptor="ejb-jar.xml"
+
+<iplanet-ejbc ejbdescriptor="ejb-jar.xml"
               iasdescriptor="ias-ejb-jar.xml"
               dest="${build.classesdir}"
               classpath="${ias.ejbc.cpath}"/>
@@ -1361,8 +1364,8 @@ the classpath of the ejbdeploy tool and set the websphere.home property (
 in the descriptor dir:

-     <property name="webpshere.home" value="${was4.home}"/>
-     <ejbjar srcdir="${build.class}" descriptordir="etc/ejb">
+    <property name="webpshere.home" value="${was4.home}"/>
+    <ejbjar srcdir="${build.class}" descriptordir="etc/ejb">
       <include name="*-ejb-jar.xml"/>
       <websphere dbvendor="DB2UDBOS390_V6"
                  ejbdeploy="true"
@@ -1377,9 +1380,9 @@ in the descriptor dir:

<pathelement location="${was4.home}/lib/j2ee.jar"/> <pathelement location="${was4.home}/lib/vaprt.jar"/> </wasclasspath> - <classpath> - <path refid="build.classpath"/> - </classpath> + <classpath> + <path refid="build.classpath"/> + </classpath> </websphere> <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" location="${lib}/dtd/ejb-jar_1_1.dtd"/> @@ -1491,7 +1494,8 @@ This example demonstrates the typical use of the <iplanet> ne It will name each EJB-JAR using the "basename" prepended to each standard EJB descriptor. For example, if the descriptor named "Account-ejb-jar.xml" is processed, the EJB-JAR will be named "Account.jar" -
    <ejbjar srcdir="${build.classesdir}"
+
+    <ejbjar srcdir="${build.classesdir}"
             descriptordir="${src}">
 
             <iplanet destdir="${assemble.ejbjar}"
@@ -1502,7 +1506,8 @@ is processed, the EJB-JAR will be named "Account.jar"
 
 This example demonstrates the use of a nested classpath element as well
 as some of the other optional attributes.
-
    <ejbjar srcdir="${build.classesdir}"
+
+    <ejbjar srcdir="${build.classesdir}"
             descriptordir="${src}">
 
             <iplanet destdir="${assemble.ejbjar}"
@@ -1522,7 +1527,8 @@ This example demonstrates the use of basejarname attribute.  In this
 case, the completed EJB-JAR will be named "HelloWorld.jar"  If multiple
 EJB descriptors might be found, care must be taken to ensure that the completed
 JAR files don't overwrite each other.
-
    <ejbjar srcdir="${build.classesdir}"
+
+    <ejbjar srcdir="${build.classesdir}"
             descriptordir="${src}"
             basejarname="HelloWorld">
 
@@ -1536,7 +1542,8 @@ copies of the DTDs are included in the classpath, they will be automatically
 referenced without the nested elements.  In iAS 6.0 SP2, these local DTDs are
 found in the [iAS-install-directory]/APPS directory.  In iAS 6.0 SP3, these
 local DTDs are found in the [iAS-install-directory]/dtd directory.
-
    <ejbjar srcdir="${build.classesdir}"
+
+    <ejbjar srcdir="${build.classesdir}"
             descriptordir="${src}">
             <iplanet destdir="${assemble.ejbjar}">
                      classpath="${ias.ejbc.cpath}"/>
diff --git a/docs/manual/OptionalTasks/ftp.html b/docs/manual/OptionalTasks/ftp.html
index 2660feddc..5a20c546c 100644
--- a/docs/manual/OptionalTasks/ftp.html
+++ b/docs/manual/OptionalTasks/ftp.html
@@ -291,8 +291,7 @@ to the default directory for that user.

remotedir="incoming" userid="anonymous" password="me@myorg.com" - depends="yes" - > + depends="yes"> <fileset dir="htdocs/manual"/> </ftp>

Logs in to ftp.apache.org as anonymous and @@ -305,8 +304,7 @@ for anonymous.

userid="coder" password="java1" depends="yes" - binary="no" - > + binary="no"> <fileset dir="htdocs/manual"> <include name="**/*.html"/> </fileset> @@ -320,13 +318,11 @@ changed HTML files in the htdocs/manual directory to the userid="coder" password="java1" separator="\" - verbose="yes"
-
-  >
+       verbose="yes">
     <fileset dir="htdocs/manual">
       <include name="**/*.html"/>
     </fileset>
-  </ftp>

Logs in to the Windows-based ftp.nt.org as + </ftp>

Logs in to the Windows-based ftp.nt.org as coder with password java1 and uploads all HTML files in the htdocs/manual directory to the c:\uploads directory. Progress messages are displayed as each diff --git a/docs/manual/OptionalTasks/icontract.html b/docs/manual/OptionalTasks/icontract.html index 891e831b1..3675e62d3 100644 --- a/docs/manual/OptionalTasks/icontract.html +++ b/docs/manual/OptionalTasks/icontract.html @@ -153,8 +153,7 @@ Instruments Java classes with i controlfile="control" targets="targets" verbosity="error*,warning*" - quiet="true" - > + quiet="true"> <classpath refid="compile-classpath"/> </icontract>

diff --git a/docs/manual/OptionalTasks/jpcoverage.html b/docs/manual/OptionalTasks/jpcoverage.html index 20c8b6fbf..ae0ff16b8 100644 --- a/docs/manual/OptionalTasks/jpcoverage.html +++ b/docs/manual/OptionalTasks/jpcoverage.html @@ -27,6 +27,10 @@ and is not intended as a replacement to the manual.

Tasks

+ + + + @@ -249,7 +253,8 @@ with a name attribute.

Example of filters

-
<filters>
+  
+<filters>
     <include class="com.mycompany.*" method="*"/>
     <exclude class="com.mycompany.MyClass" method="test*"/>
 </filters>
@@ -485,13 +490,14 @@ with a class and  method attribute.

Example of report

-
<jpcovreport home="c:\jprobe" snapshot="merge.jpc" format="xml" tofile="result.xml">
-  <sourcepath path="./src"/>
+
+<jpcovreport home="c:\jprobe" snapshot="merge.jpc" format="xml" tofile="result.xml">
+  <sourcepath path="./src"/>
   <reference>
-    <classpath path="./bin/classes"/>
+    <classpath path="./bin/classes"/>
     <filters>
-      <include class="com.mycompany.*"/>
-      <exclude class="com.mycompany.MyClass" method="test*"/>
+      <include class="com.mycompany.*"/>
+      <exclude class="com.mycompany.MyClass" method="test*"/>
     </filters>
   </reference>
 </jpcovreport>
@@ -510,7 +516,7 @@ say bin/classes and test/classes. You should mostly end up with a reference such
 as:

<reference>
-    <classpath path="./bin/classes"/>
+    <classpath path="./bin/classes"/>
 </reference>

With such a reference, your XML report will be cleaned up against parasite @@ -522,14 +528,14 @@ This file can be used to generate a framed report a la javadoc similar to the one for JUnit. It needs either Xalan 1.2.2 or Xalan 2.x.

Xalan 1.2.2 (you must have xalan.jar and bsf.jar in your classpath)

-
<style processor="xalan" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
- style="${ant.home}/etc/coverage-frames.xsl">
-    <param name="output.dir" expression="'${basedir}/reports/html'"/>
+
<style processor="xalan" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
+ style="${ant.home}/etc/coverage-frames.xsl">
+    <param name="output.dir" expression="'${basedir}/reports/html'"/>
 </style>

Xalan 2.x (note the parameter without single quote)

-
<style processor="trax" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
- style="${ant.home}/etc/coverage-frames.xsl">
-  <param name="output.dir" expression="${basedir}/reports/html"/>
+
<style processor="trax" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
+ style="${ant.home}/etc/coverage-frames.xsl">
+  <param name="output.dir" expression="${basedir}/reports/html"/>
 </style>

diff --git a/docs/manual/OptionalTasks/jspc.html b/docs/manual/OptionalTasks/jspc.html index 30035662f..bb52483d5 100644 --- a/docs/manual/OptionalTasks/jspc.html +++ b/docs/manual/OptionalTasks/jspc.html @@ -240,7 +240,6 @@ When used, the task hands off all dependency checking to the compiler. Build all jsp pages under src/war into the destination /gensrc, in a package hierarchy beginning with com.i3sp.jsp.
-
 <jspc
       destdir="interim"
       verbose="1"
diff --git a/docs/manual/OptionalTasks/perforce.html b/docs/manual/OptionalTasks/perforce.html
index 1572c174f..20f1241ce 100644
--- a/docs/manual/OptionalTasks/perforce.html
+++ b/docs/manual/OptionalTasks/perforce.html
@@ -38,6 +38,10 @@ You will also need the Perforce client executable (p4 or p4.exe but not p4win.ex
 

The Tasks

TaskDescription
JPCoverage Measure coverage of Java code.
+ + + +
TaskDescription
P4Sync Synchronise a workspace to a depot