Browse Source

Various typos and documentation fixes.

PR: 1464, 1483, 1523, 1873, 1621, 1839, 1840, 2011
Submitted by:	Daniel.Barclay@digitalfocus.com
                colin@bspark.com (Colin Sampaleanu)
                daveg@permabit.com
                arosen@silverstream.com (Alex Rosen)
                rxh@gers.com (Rey Hernandez)


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269169 13f79535-47bb-0310-9956-ffa450edef68
master
Stefan Bodewig 24 years ago
parent
commit
a891255928
9 changed files with 46 additions and 8 deletions
  1. +2
    -1
      docs/manual/CoreTasks/delete.html
  2. +2
    -0
      docs/manual/CoreTasks/javac.html
  3. +1
    -1
      docs/manual/CoreTasks/javadoc.html
  4. +1
    -0
      docs/manual/CoreTasks/style.html
  5. +2
    -1
      docs/manual/coretasklist.html
  6. +12
    -2
      docs/manual/install.html
  7. +24
    -1
      docs/manual/running.html
  8. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Mkdir.java
  9. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java

+ 2
- 1
docs/manual/CoreTasks/delete.html View File

@@ -38,7 +38,8 @@ To remove empty directories, use the <em>includeEmptyDirs</em> atribute.</p>
<tr> <tr>
<td valign="top">quiet</td> <td valign="top">quiet</td>
<td valign="top">If the file does not exist, do not display a diagnostic <td valign="top">If the file does not exist, do not display a diagnostic
message or modify the exit status to reflect an error.
message or modify the exit status to reflect an error (unless Ant
has been invoked with the -verbose or -debug switches).
This means that if a file or directory cannot be deleted, This means that if a file or directory cannot be deleted,
then no error is reported. This setting emulates the then no error is reported. This setting emulates the
-f option to the Unix &quot;rm&quot; command. -f option to the Unix &quot;rm&quot; command.


+ 2
- 0
docs/manual/CoreTasks/javac.html View File

@@ -45,6 +45,8 @@ supplied, write a class that implements the CompilerAdapter interface
(package org.apache.tools.ant.taskdefs.compilers). Supply the full (package org.apache.tools.ant.taskdefs.compilers). Supply the full
classname in the &quot;build.compiler&quot; property. classname in the &quot;build.compiler&quot; property.
</p> </p>
<p>This task will drop all entries that point to non-existant
files/directories from the CLASSPATH it passes to the compiler.</p>
<h3>Parameters</h3> <h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0"> <table border="1" cellpadding="2" cellspacing="0">
<tr> <tr>


+ 1
- 1
docs/manual/CoreTasks/javadoc.html View File

@@ -248,7 +248,7 @@ instead.</i></p>
<tr> <tr>
<td valign="top">linkoffline</td> <td valign="top">linkoffline</td>
<td valign="top">Link to docs at &lt;url&gt; using package list at <td valign="top">Link to docs at &lt;url&gt; using package list at
&lt;url2&gt;</td>
&lt;url2&gt; - separate the URLs by using a space character.</td>
<td align="center" valign="top">1.2</td> <td align="center" valign="top">1.2</td>
<td align="center" valign="top">No</td> <td align="center" valign="top">No</td>
</tr> </tr>


+ 1
- 0
docs/manual/CoreTasks/style.html View File

@@ -27,6 +27,7 @@ inclusion/exclusion of files works, and how to write patterns.</p>
and <code>&lt;patternset&gt;</code> elements.</p> and <code>&lt;patternset&gt;</code> elements.</p>
<p>Style supports the use of a &lt;param&gt; element which is used to pass values <p>Style supports the use of a &lt;param&gt; element which is used to pass values
to an &lt;xsl:param&gt; declaration.</p> to an &lt;xsl:param&gt; declaration.</p>
<p>If you want to use Xalan-J 1 or XSL:P, you also need Ant's optional.jar</p>
<h3>Parameters</h3> <h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0"> <table border="1" cellpadding="2" cellspacing="0">
<tr> <tr>


+ 2
- 1
docs/manual/coretasklist.html View File

@@ -18,6 +18,7 @@
<a href="CoreTypes/mapper.html">File Mappers</a><br> <a href="CoreTypes/mapper.html">File Mappers</a><br>


<h3>Core Tasks</h3> <h3>Core Tasks</h3>
<a href="CoreTasks/common.html">Common Attributes</a><br>
<a href="CoreTasks/ant.html">Ant</a><br> <a href="CoreTasks/ant.html">Ant</a><br>
<a href="CoreTasks/antcall.html">AntCall</a><br> <a href="CoreTasks/antcall.html">AntCall</a><br>
<a href="CoreTasks/antstructure.html">AntStructure</a><br> <a href="CoreTasks/antstructure.html">AntStructure</a><br>
@@ -31,6 +32,7 @@
<a href="CoreTasks/cvspass.html">CVSPass</a><br> <a href="CoreTasks/cvspass.html">CVSPass</a><br>
<a href="CoreTasks/delete.html">Delete</a><br> <a href="CoreTasks/delete.html">Delete</a><br>
<a href="CoreTasks/deltree.html"><i>Deltree</i></a><br> <a href="CoreTasks/deltree.html"><i>Deltree</i></a><br>
<a href="CoreTasks/ear.html">Ear</a><br>
<a href="CoreTasks/echo.html">Echo</a><br> <a href="CoreTasks/echo.html">Echo</a><br>
<a href="CoreTasks/exec.html">Exec</a><br> <a href="CoreTasks/exec.html">Exec</a><br>
<a href="CoreTasks/execon.html">ExecOn</a><br> <a href="CoreTasks/execon.html">ExecOn</a><br>
@@ -71,4 +73,3 @@
<a href="CoreTasks/zip.html">Zip</a><br> <a href="CoreTasks/zip.html">Zip</a><br>
</body> </body>
</html> </html>


+ 12
- 2
docs/manual/install.html View File

@@ -73,8 +73,10 @@ Before you can run ant there is some additional set up you
will need to do:</p> will need to do:</p>
<ul> <ul>
<li>Add the <code>bin</code> directory to your path.</li> <li>Add the <code>bin</code> directory to your path.</li>
<li>Set the <code>ANT_HOME</code> environment variable to
the directory where you installed Ant.</li>
<li>Set the <code>ANT_HOME</code> environment variable to the
directory where you installed Ant. On some operating systems the ant
wrapper scripts can guess <code>ANT_HOME</code> (Unix dialects and
Windows NT/2000) - but it is better to not rely on this behavior.</li>
<li>Optionally, set the <code>JAVA_HOME</code> environment variable <li>Optionally, set the <code>JAVA_HOME</code> environment variable
(see the <a href="#advanced">Advanced</a> section below). (see the <a href="#advanced">Advanced</a> section below).
This should be set to the directory where your JDK is installed.</li> This should be set to the directory where your JDK is installed.</li>
@@ -209,6 +211,14 @@ needed for use with the mappers.</p>
<td><b>Needed For</b></td> <td><b>Needed For</b></td>
<td><b>Available At</b></td> <td><b>Available At</b></td>
</tr> </tr>
<tr>
<td>An XSL transformer like Xalan or XSL:P</td>
<td>style task</td>
<td><a href="http://xml.apache.org/xalan-j/index.html"
target="_top">http://xml.apache.org/xalan-j/index.html</a> or <a
href="http://www.clc-marketing.com/xslp/"
target="_top">http://www.clc-marketing.com/xslp/</a></td>
</tr>
<tr> <tr>
<td>jakarta-regexp-1.2.jar</td> <td>jakarta-regexp-1.2.jar</td>
<td>regexp type with mappers</td> <td>regexp type with mappers</td>


+ 24
- 1
docs/manual/running.html View File

@@ -90,7 +90,30 @@ target called <code>dist</code>.</p>
target called <code>dist</code>, setting the <code>build</code> property to the target called <code>dist</code>, setting the <code>build</code> property to the
value <code>build/classes</code>.</p> value <code>build/classes</code>.</p>


<h3>Running Ant by Hand</h3>
<h3>Files</h3>

<p>The Ant wrapper script for Unix will source (read and evaluate) the
file <code>~/.antrc</code> before it does anything - the Windows batch
file invokes <code>%HOME%\antrc_pre.bat</code> at the start and
<code>%HOME%\antrc_post.bat</code> at the end. You can use these
files to set/unset environment variables that should only be visible
during the execution of Ant. See the next section for example.</p>

<h3>Environment Variables</h3>

<p>The wrapper scripts use the following environment variables (if
set):</p>

<ul>
<li><code>JAVACMD</code> full path of the Java executable. Use this
to invoke a different JVM than <code>JAVA_HOME/bin/java(.exe)</code>.</li>

<li><code>ANT_OPTS</code> command line arguments that should be
passed to the JVM - for example, you can define properties or set
the maximum Java heap size here.</li>
</ul>

<h2>Running Ant by Hand</h2>
<p>If you have installed Ant in the do-it-yourself way, Ant can be started <p>If you have installed Ant in the do-it-yourself way, Ant can be started
with:</p> with:</p>
<blockquote> <blockquote>


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Mkdir.java View File

@@ -81,7 +81,7 @@ public class Mkdir extends Task {
boolean result = dir.mkdirs(); boolean result = dir.mkdirs();
if (result == false) { if (result == false) {
String msg = "Directory " + dir.getAbsolutePath() + " creation was not " + String msg = "Directory " + dir.getAbsolutePath() + " creation was not " +
"succesful for an unknown reason";
"succesfull for an unknown reason";
throw new BuildException(msg, location); throw new BuildException(msg, location);
} }
log("Created dir: " + dir.getAbsolutePath()); log("Created dir: " + dir.getAbsolutePath());


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java View File

@@ -194,7 +194,7 @@ public class MSVSSGET extends MSVSS {
boolean done = dir.mkdirs(); boolean done = dir.mkdirs();
if (done == false) { if (done == false) {
String msg = "Directory " + m_LocalPath + " creation was not " + String msg = "Directory " + m_LocalPath + " creation was not " +
"succesful for an unknown reason";
"succesfull for an unknown reason";
throw new BuildException(msg, location); throw new BuildException(msg, location);
} }
project.log("Created dir: " + dir.getAbsolutePath()); project.log("Created dir: " + dir.getAbsolutePath());


Loading…
Cancel
Save