Browse Source

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
master
Peter Reilly 20 years ago
parent
commit
a68ae35518
10 changed files with 73 additions and 56 deletions
  1. +2
    -2
      docs/manual/OptionalTasks/attrib.html
  2. +3
    -2
      docs/manual/OptionalTasks/chgrp.html
  3. +17
    -16
      docs/manual/OptionalTasks/chown.html
  4. +4
    -0
      docs/manual/OptionalTasks/dotnet.html
  5. +19
    -12
      docs/manual/OptionalTasks/ejb.html
  6. +4
    -8
      docs/manual/OptionalTasks/ftp.html
  7. +1
    -2
      docs/manual/OptionalTasks/icontract.html
  8. +19
    -13
      docs/manual/OptionalTasks/jpcoverage.html
  9. +0
    -1
      docs/manual/OptionalTasks/jspc.html
  10. +4
    -0
      docs/manual/OptionalTasks/perforce.html

+ 2
- 2
docs/manual/OptionalTasks/attrib.html View File

@@ -72,8 +72,8 @@ nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code>&lt;attrib file=&quot;${dist}/run.bat&quot; readonly=&quot;true&quot; hidden=&quot;true&quot;/&gt;</code></p>
<blockquote>
<pre>&lt;attrib file=&quot;${dist}/run.bat&quot; readonly=&quot;true&quot; hidden=&quot;true&quot;/&gt;</pre>
</blockquote> </blockquote>
<p>makes the &quot;run.bat&quot; file read-only and hidden.</p> <p>makes the &quot;run.bat&quot; file read-only and hidden.</p>
<blockquote> <blockquote>


+ 3
- 2
docs/manual/OptionalTasks/chgrp.html View File

@@ -77,8 +77,9 @@ nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and


</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code>&lt;chgrp file=&quot;${dist}/start.sh&quot; group=&quot;coders&quot;/&gt;</code></p>
<blockquote><pre>
&lt;chgrp file=&quot;${dist}/start.sh&quot; group=&quot;coders&quot;/&gt;
</pre>
</blockquote> </blockquote>
<p>makes the &quot;start.sh&quot; file belong to the coders group on a <p>makes the &quot;start.sh&quot; file belong to the coders group on a
UNIX system.</p> UNIX system.</p>


+ 17
- 16
docs/manual/OptionalTasks/chown.html View File

@@ -77,27 +77,28 @@ nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and


</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code>&lt;chown file=&quot;${dist}/start.sh&quot; owner=&quot;coderjoe&quot;/&gt;</code></p>
<blockquote><pre>
&lt;chown file="${dist}/start.sh" owner="coderjoe"/&gt;
</pre>
</blockquote> </blockquote>
<p>makes the &quot;start.sh&quot; file belong to coderjoe on a
<p>makes the "start.sh" file belong to coderjoe on a
UNIX system.</p> UNIX system.</p>
<blockquote> <blockquote>
<pre> <pre>
&lt;chown owner=&quot;coderjoe&quot;&gt;
&lt;fileset dir=&quot;${dist}/bin&quot; includes=&quot;**/*.sh&quot;/&gt;
&lt;chown owner="coderjoe"&gt;
&lt;fileset dir="${dist}/bin" includes="**/*.sh"/&gt;
&lt;/chown&gt; &lt;/chown&gt;
</pre> </pre>
</blockquote> </blockquote>
<p>makes all &quot;.sh&quot; files below <code>${dist}/bin</code>
<p>makes all ".sh" files below <code>${dist}/bin</code>
belong to coderjoe on a UNIX system.</p> belong to coderjoe on a UNIX system.</p>
<blockquote> <blockquote>
<pre> <pre>
&lt;chown owner=&quot;coderjoe&quot;&gt;
&lt;fileset dir=&quot;shared/sources1&quot;&gt;
&lt;exclude name=&quot;**/trial/**&quot;/&gt;
&lt;chown owner="coderjoe"&gt;
&lt;fileset dir="shared/sources1"&gt;
&lt;exclude name="**/trial/**"/&gt;
&lt;/fileset&gt; &lt;/fileset&gt;
&lt;fileset refid=&quot;other.shared.sources&quot;/&gt;
&lt;fileset refid="other.shared.sources"/&gt;
&lt;/chown&gt; &lt;/chown&gt;
</pre> </pre>
</blockquote> </blockquote>
@@ -109,13 +110,13 @@ owner.</p>


<blockquote> <blockquote>
<pre> <pre>
&lt;chown owner=&quot;webadmin&quot; type=&quot;file&quot;&gt;
&lt;fileset dir=&quot;/web&quot;&gt;
&lt;include name=&quot;**/*.cgi&quot;/&gt;
&lt;include name=&quot;**/*.old&quot;/&gt;
&lt;chown owner="webadmin" type="file"&gt;
&lt;fileset dir="/web"&gt;
&lt;include name="**/*.cgi"/&gt;
&lt;include name="**/*.old"/&gt;
&lt;/fileset&gt; &lt;/fileset&gt;
&lt;dirset dir=&quot;/web&quot;&gt;
&lt;include name=&quot;**/private_*&quot;/&gt;
&lt;dirset dir="/web"&gt;
&lt;include name="**/private_*"/&gt;
&lt;/dirset&gt; &lt;/dirset&gt;
&lt;/chmod&gt; &lt;/chmod&gt;
</pre> </pre>


+ 4
- 0
docs/manual/OptionalTasks/dotnet.html View File

@@ -64,6 +64,10 @@ can, however, be done if absolutely necessary.
<h3>Task List</h3> <h3>Task List</h3>


<table border="0" > <table border="0" >
<tr>
<td><b>Task</b></td>
<td><b>Description</b></td>
</tr>
<tr> <tr>
<td><a href="csc.html">Csc</a></td> <td><a href="csc.html">Csc</a></td>
<td>Compiles C# code</td> <td>Compiles C# code</td>


+ 19
- 12
docs/manual/OptionalTasks/ejb.html View File

@@ -107,7 +107,8 @@ is based on the standard Ant include and exclude selection mechanisms.
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<pre>&lt;ddcreator descriptors=&quot;${dd.dir}&quot;
<pre>
&lt;ddcreator descriptors=&quot;${dd.dir}&quot;
dest=&quot;${gen.classes}&quot; dest=&quot;${gen.classes}&quot;
classpath=&quot;${descriptorbuild.classpath}&quot;&gt; classpath=&quot;${descriptorbuild.classpath}&quot;&gt;
&lt;include name=&quot;*.txt&quot;/&gt; &lt;include name=&quot;*.txt&quot;/&gt;
@@ -177,7 +178,8 @@ or are out of date, the ejbc tool is run to generate new versions.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<pre>&lt;ejbc descriptors=&quot;${gen.classes}&quot;
<pre>
&lt;ejbc descriptors=&quot;${gen.classes}&quot;
src=&quot;${src.dir}&quot; src=&quot;${src.dir}&quot;
dest=&quot;${gen.classes}&quot; dest=&quot;${gen.classes}&quot;
manifest=&quot;${build.manifest}&quot; manifest=&quot;${build.manifest}&quot;
@@ -291,7 +293,8 @@ directory. If omitted, the ejbc utility must be on the user's system path. </td>
<h3> <h3>
Examples</h3> Examples</h3>


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


<pre> <pre>
&lt;property name=&quot;webpshere.home&quot; value=&quot;${was4.home}&quot;/&gt;
&lt;ejbjar srcdir="${build.class}" descriptordir="etc/ejb"&gt;
&lt;property name=&quot;webpshere.home&quot; value=&quot;${was4.home}&quot;/&gt;
&lt;ejbjar srcdir="${build.class}" descriptordir="etc/ejb"&gt;
&lt;include name="*-ejb-jar.xml"/&gt; &lt;include name="*-ejb-jar.xml"/&gt;
&lt;websphere dbvendor="DB2UDBOS390_V6" &lt;websphere dbvendor="DB2UDBOS390_V6"
ejbdeploy="true" ejbdeploy="true"
@@ -1377,9 +1380,9 @@ in the descriptor dir:</p>
&lt;pathelement location="${was4.home}/lib/j2ee.jar"/&gt; &lt;pathelement location="${was4.home}/lib/j2ee.jar"/&gt;
&lt;pathelement location="${was4.home}/lib/vaprt.jar"/&gt; &lt;pathelement location="${was4.home}/lib/vaprt.jar"/&gt;
&lt;/wasclasspath&gt; &lt;/wasclasspath&gt;
&lt;classpath&gt;
&lt;path refid="build.classpath"/&gt;
&lt;/classpath&gt;
&lt;classpath&gt;
&lt;path refid="build.classpath"/&gt;
&lt;/classpath&gt;
&lt;/websphere&gt; &lt;/websphere&gt;
&lt;dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" &lt;dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
location="${lib}/dtd/ejb-jar_1_1.dtd"/&gt; location="${lib}/dtd/ejb-jar_1_1.dtd"/&gt;
@@ -1491,7 +1494,8 @@ This example demonstrates the typical use of the <code>&lt;iplanet&gt;</code> ne
It will name each EJB-JAR using the "basename" prepended to each standard 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" EJB descriptor. For example, if the descriptor named "Account-ejb-jar.xml"
is processed, the EJB-JAR will be named "Account.jar" is processed, the EJB-JAR will be named "Account.jar"
<pre> &lt;ejbjar srcdir="${build.classesdir}"
<pre>
&lt;ejbjar srcdir="${build.classesdir}"
descriptordir="${src}"&gt; descriptordir="${src}"&gt;


&lt;iplanet destdir="${assemble.ejbjar}" &lt;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 This example demonstrates the use of a nested classpath element as well
as some of the other optional attributes. as some of the other optional attributes.
<pre> &lt;ejbjar srcdir="${build.classesdir}"
<pre>
&lt;ejbjar srcdir="${build.classesdir}"
descriptordir="${src}"&gt; descriptordir="${src}"&gt;


&lt;iplanet destdir="${assemble.ejbjar}" &lt;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 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 EJB descriptors might be found, care must be taken to ensure that the completed
JAR files don't overwrite each other. JAR files don't overwrite each other.
<pre> &lt;ejbjar srcdir="${build.classesdir}"
<pre>
&lt;ejbjar srcdir="${build.classesdir}"
descriptordir="${src}" descriptordir="${src}"
basejarname="HelloWorld"&gt; basejarname="HelloWorld"&gt;


@@ -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 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 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. local DTDs are found in the [iAS-install-directory]/dtd directory.
<pre> &lt;ejbjar srcdir="${build.classesdir}"
<pre>
&lt;ejbjar srcdir="${build.classesdir}"
descriptordir="${src}"&gt; descriptordir="${src}"&gt;
&lt;iplanet destdir="${assemble.ejbjar}"&gt; &lt;iplanet destdir="${assemble.ejbjar}"&gt;
classpath="${ias.ejbc.cpath}"/&gt; classpath="${ias.ejbc.cpath}"/&gt;


+ 4
- 8
docs/manual/OptionalTasks/ftp.html View File

@@ -291,8 +291,7 @@ to the default directory for that user.</p>
remotedir=&quot;incoming&quot; remotedir=&quot;incoming&quot;
userid=&quot;anonymous&quot; userid=&quot;anonymous&quot;
password=&quot;me@myorg.com&quot; password=&quot;me@myorg.com&quot;
depends=&quot;yes&quot;
&gt;
depends=&quot;yes&quot;&gt;
&lt;fileset dir=&quot;htdocs/manual&quot;/&gt; &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;
&lt;/ftp&gt;</pre> &lt;/ftp&gt;</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
@@ -305,8 +304,7 @@ for <code>anonymous</code>.</p>
userid=&quot;coder&quot; userid=&quot;coder&quot;
password=&quot;java1&quot; password=&quot;java1&quot;
depends=&quot;yes&quot; depends=&quot;yes&quot;
binary=&quot;no&quot;
&gt;
binary=&quot;no&quot;&gt;
&lt;fileset dir=&quot;htdocs/manual&quot;&gt; &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
&lt;include name=&quot;**/*.html&quot;/&gt; &lt;include name=&quot;**/*.html&quot;/&gt;
&lt;/fileset&gt; &lt;/fileset&gt;
@@ -320,13 +318,11 @@ changed HTML files in the <code>htdocs/manual</code> directory to the
userid=&quot;coder&quot; userid=&quot;coder&quot;
password=&quot;java1&quot; password=&quot;java1&quot;
separator=&quot;\&quot; separator=&quot;\&quot;
verbose=&quot;yes&quot;</pre>
<PRE>
&gt;
verbose=&quot;yes&quot;&gt;
&lt;fileset dir=&quot;htdocs/manual&quot;&gt; &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
&lt;include name=&quot;**/*.html&quot;/&gt; &lt;include name=&quot;**/*.html&quot;/&gt;
&lt;/fileset&gt; &lt;/fileset&gt;
&lt;/ftp&gt;</PRE><p>Logs in to the Windows-based <code>ftp.nt.org</code> as
&lt;/ftp&gt;</pre><p>Logs in to the Windows-based <code>ftp.nt.org</code> as
<code>coder</code> with password <code>java1</code> and uploads all <code>coder</code> with password <code>java1</code> and uploads all
HTML files in the <code>htdocs/manual</code> directory to the HTML files in the <code>htdocs/manual</code> directory to the
<code>c:\uploads</code> directory. Progress messages are displayed as each <code>c:\uploads</code> directory. Progress messages are displayed as each


+ 1
- 2
docs/manual/OptionalTasks/icontract.html View File

@@ -153,8 +153,7 @@ Instruments Java classes with <a href="http://www.reliable-systems.com/tools/">i
controlfile=&quot;control&quot; controlfile=&quot;control&quot;
targets=&quot;targets&quot; targets=&quot;targets&quot;
verbosity=&quot;error*,warning*&quot; verbosity=&quot;error*,warning*&quot;
quiet=&quot;true&quot;
&gt;
quiet=&quot;true&quot;&gt;
&lt;classpath refid=&quot;compile-classpath&quot;/&gt; &lt;classpath refid=&quot;compile-classpath&quot;/&gt;
&lt;/icontract&gt; &lt;/icontract&gt;
</pre> </pre>


+ 19
- 13
docs/manual/OptionalTasks/jpcoverage.html View File

@@ -27,6 +27,10 @@ and is not intended as a replacement to the manual.


<h2>Tasks</h2> <h2>Tasks</h2>
<table border="0" cellspacing="0" cellpadding="3"> <table border="0" cellspacing="0" cellpadding="3">
<tr>
<td><b>Task</b></td>
<td><b>Description</b></td>
</tr>
<tr> <tr>
<td><a href="#jpcoverage">JPCoverage</a></td> <td><a href="#jpcoverage">JPCoverage</a></td>
<td>Measure coverage of Java code.</td> <td>Measure coverage of Java code.</td>
@@ -249,7 +253,8 @@ with a <tt>name</tt> attribute.


<h3>Example of filters</h3> <h3>Example of filters</h3>
<blockquote> <blockquote>
<pre>&lt;filters&gt;
<pre>
&lt;filters&gt;
&lt;include class=&quot;com.mycompany.*&quot; method=&quot;*&quot;/&gt; &lt;include class=&quot;com.mycompany.*&quot; method=&quot;*&quot;/&gt;
&lt;exclude class=&quot;com.mycompany.MyClass&quot; method=&quot;test*&quot;/&gt; &lt;exclude class=&quot;com.mycompany.MyClass&quot; method=&quot;test*&quot;/&gt;
&lt;/filters&gt;</pre> &lt;/filters&gt;</pre>
@@ -485,13 +490,14 @@ with a <tt>class </tt>and&nbsp; <tt>method </tt>attribute.


<h3>Example of report</h3> <h3>Example of report</h3>
<blockquote> <blockquote>
<pre>&lt;jpcovreport home=&quot;c:\jprobe&quot; snapshot=&quot;merge.jpc&quot; format=&quot;xml&quot; tofile=&quot;result.xml&quot;&gt;
&lt;sourcepath path=&quot;./src&quot;/&gt;
<pre>
&lt;jpcovreport home="c:\jprobe" snapshot="merge.jpc" format="xml" tofile="result.xml"&gt;
&lt;sourcepath path="./src"/&gt;
&lt;reference&gt; &lt;reference&gt;
&lt;classpath path=&quot;./bin/classes&quot;/&gt;
&lt;classpath path="./bin/classes"/&gt;
&lt;filters&gt; &lt;filters&gt;
&lt;include class=&quot;com.mycompany.*&quot;/&gt;
&lt;exclude class=&quot;com.mycompany.MyClass&quot; method=&quot;test*&quot;/&gt;
&lt;include class="com.mycompany.*"/&gt;
&lt;exclude class="com.mycompany.MyClass" method="test*"/&gt;
&lt;/filters&gt; &lt;/filters&gt;
&lt;/reference&gt; &lt;/reference&gt;
&lt;/jpcovreport&gt; &lt;/jpcovreport&gt;
@@ -510,7 +516,7 @@ say bin/classes and test/classes. You should mostly end up with a reference such
as:</p> as:</p>
<blockquote> <blockquote>
<pre>&lt;reference&gt; <pre>&lt;reference&gt;
&nbsp;&nbsp;&nbsp; &lt;classpath path=&quot;./bin/classes&quot;/&gt;
&nbsp;&nbsp;&nbsp; &lt;classpath path="./bin/classes"/&gt;
&lt;/reference&gt;</pre> &lt;/reference&gt;</pre>
</blockquote> </blockquote>
<p>With such a reference, your XML report will be cleaned up against parasite <p>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.</p> one for JUnit. It needs either Xalan 1.2.2 or Xalan 2.x.</p>
<p>Xalan 1.2.2 (you must have xalan.jar and bsf.jar in your classpath) <p>Xalan 1.2.2 (you must have xalan.jar and bsf.jar in your classpath)
</p> </p>
<pre>&lt;style processor=&quot;xalan&quot; in=&quot;./reports/xml/results.xml&quot; out=&quot;./reports/html/dummy.file&quot;
style=&quot;${ant.home}/etc/coverage-frames.xsl&quot;&gt;
&lt;param name=&quot;output.dir&quot; expression=&quot;'${basedir}/reports/html'&quot;/&gt;
<pre>&lt;style processor="xalan" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
style="${ant.home}/etc/coverage-frames.xsl"&gt;
&lt;param name="output.dir" expression="'${basedir}/reports/html'"/&gt;
&lt;/style&gt;</pre> &lt;/style&gt;</pre>
<p>Xalan 2.x (note the parameter without single quote)</p> <p>Xalan 2.x (note the parameter without single quote)</p>
<pre>&lt;style processor=&quot;trax&quot; in=&quot;./reports/xml/results.xml&quot; out=&quot;./reports/html/dummy.file&quot;
style=&quot;${ant.home}/etc/coverage-frames.xsl&quot;&gt;
&nbsp; &lt;param name=&quot;output.dir&quot; expression=&quot;${basedir}/reports/html&quot;/&gt;
<pre>&lt;style processor="trax" in="./reports/xml/results.xml" out="./reports/html/dummy.file"
style="${ant.home}/etc/coverage-frames.xsl"&gt;
&nbsp; &lt;param name="output.dir" expression="${basedir}/reports/html"/&gt;
&lt;/style&gt;</pre> &lt;/style&gt;</pre>


<hr> <hr>


+ 0
- 1
docs/manual/OptionalTasks/jspc.html View File

@@ -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 Build all jsp pages under src/war into the destination /gensrc, in a
package hierarchy beginning with com.i3sp.jsp. package hierarchy beginning with com.i3sp.jsp.
<pre> <pre>

&lt;jspc &lt;jspc
destdir="interim" destdir="interim"
verbose="1" verbose="1"


+ 4
- 0
docs/manual/OptionalTasks/perforce.html View File

@@ -38,6 +38,10 @@ You will also need the Perforce client executable (p4 or p4.exe but not p4win.ex
<h2><a name="tasks">The Tasks</a></h2> <h2><a name="tasks">The Tasks</a></h2>


<table border="0" cellspacing="0" cellpadding="3"> <table border="0" cellspacing="0" cellpadding="3">
<tr>
<td><b>Task</b></td>
<td><b>Description</b></td>
</tr>
<tr> <tr>
<td><a href="#p4sync">P4Sync</a></td> <td><a href="#p4sync">P4Sync</a></td>
<td>Synchronise a workspace to a depot</td> <td>Synchronise a workspace to a depot</td>


Loading…
Cancel
Save