From df47422dab524223eae5669c7a2d0d152a4803ff Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Thu, 28 Feb 2002 22:40:18 +0000 Subject: [PATCH] logo on start page, bit of troubleshooting on the feedback page before the mail list; platform issues page git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271619 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/cover.html | 25 ++++++++++++++++ docs/manual/feedback.html | 37 +++++++++++++++++++++--- docs/manual/index.html | 2 +- docs/manual/installlist.html | 15 ++++++---- docs/manual/platform.html | 55 ++++++++++++++++++++++++++++++++++++ docs/manual/toc.html | 3 +- 6 files changed, 125 insertions(+), 12 deletions(-) create mode 100644 docs/manual/cover.html create mode 100644 docs/manual/platform.html diff --git a/docs/manual/cover.html b/docs/manual/cover.html new file mode 100644 index 000000000..08df8b9db --- /dev/null +++ b/docs/manual/cover.html @@ -0,0 +1,25 @@ + + + + +Apache Ant 1.5 User Manual - Credits + + + +
+

+

Apache Ant 1.5 Manual

+

This is the manual for version 1.5 of Apache Ant. If your version + of ant (as verified with ant -version) is older or newer than this + version then this is not the correct manual set. Please use the documentation + appropriate to your current version.

+

 

+
+ + +
+

Copyright © 2001-2002 Apache Software Foundation. All rights +Reserved.

+ + + diff --git a/docs/manual/feedback.html b/docs/manual/feedback.html index f5fd074d2..cea9baa94 100644 --- a/docs/manual/feedback.html +++ b/docs/manual/feedback.html @@ -7,10 +7,39 @@ -

Feedback

-

To provide feedback on this software, please subscribe to the -Ant User Mailing List -

+

Feedback and Troubleshooting

+

If things do not work, especially simple things like ant -version, + then something is wrong with your configuration. Before filing bug reports and + emailing all the ant mailing lists

+
    +
  1. Check your environment variables. Are ANT_HOME and JAVA_HOME correct? If + they have quotes or trailing slashes, remove them.
    2. +
  2. Unset CLASSPATH; if that is wrong things go horribly wrong. Ant does not + need the CLASSPATH variable defined to anything to work.
    3. +
  3. Make sure there are no versions of crimson.jar or other XML parsers in JRE/ext
    4. +
  4. Is your path correct? is Ant on it? What about JDK/bin? have you tested + this? If you are using Jikes, is it on the path? A createProcess error (especially + with ID=2 on windows) usually means executable not found on the path.
    5. +
  5. Which version of ant are you running? Other applications distribute a copy + -it may be being picked up by accident.
    6. +
  6. If a task is failing to run is optional.jar in ANT_HOME/lib? Are there any + libraries which it depends on missing?
    7. +
  7. If a task doesn't do what you expect, run ant -verbose or ant + -debug to see what is happening
    8. +
+

If you can't fix your problem, start with the Ant + User Mailing List . These are other ant users who will help you learn to + use ant. If they cannot fix it then someone may suggest filing a bug report, + which will escalate the issue. Remember of course, that support, like all open + source development tasks, is voluntary. If you haven't invested time in helping + yourself by following the steps above, it is unlikely that anyone will invest + the time in helping you.

+

Also, if you don't understand something, the Ant + User Mailing List is the place to ask questions. Not the developer list, + nor the individuals whose names appears in the source and documentation. If + they answered all such emails, nobody would have any time to improve ant.

+

To provide feedback on this software, please subscribe to the Ant + User Mailing List

If you want to contribute to Ant or stay current with the latest development, join the diff --git a/docs/manual/index.html b/docs/manual/index.html index 569b8fa60..468b7a06f 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -7,7 +7,7 @@ - + <H2>Apache Ant User Manual</H2> diff --git a/docs/manual/installlist.html b/docs/manual/installlist.html index fd4442a49..ae6e2ca25 100644 --- a/docs/manual/installlist.html +++ b/docs/manual/installlist.html @@ -11,12 +11,15 @@ <h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> <h3>Installing Ant</h3> -<a href="install.html#getting">Getting Ant</a><br> -<a href="install.html#sysrequirements">System Requirements</a><br> -<a href="install.html#installing">Installing Ant</a><br> -<a href="install.html#buildingant">Building Ant</a><br> -<a href="install.html#librarydependencies">Library Dependencies</a><br> - +<p><a href="install.html#getting">Getting Ant</a><br> + <a href="install.html#sysrequirements">System Requirements</a><br> + <a href="install.html#installing">Installing Ant</a><br> + <a href="install.html#buildingant">Building Ant</a><br> + <a href="install.html#librarydependencies">Library Dependencies</a><br> + <a href="platform.html">Platform Specific Issues</a><br> +</p> +<p><br> +</p> </body> </html> diff --git a/docs/manual/platform.html b/docs/manual/platform.html new file mode 100644 index 000000000..27dc88ee0 --- /dev/null +++ b/docs/manual/platform.html @@ -0,0 +1,55 @@ +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<title>Platform Issues</title> +</head> + +<h1>Platform Issues</h1> + + +<h2>Unix</h2> + +<ul> +<li> You should use a GNU version of <tt>tar</tt> to untar the ant source tree, +if you have downloaded this as a tar file. +</li> +<li> Ant does not preserve file permissions when a file is copied, moved or +archived. Use <tt>&lt;chmod&gt;</tt> to set permissions, and when creating a +tar archive, use the <tt>mode</tt> attribute of <tt>&lt;tarfileset&gt;</tt> +to set the permissions in the tar file. +</li> +<li> Ant is not symbolic link aware in moves, deletes and when recursing down a tree +of directories to build up a list of files. Unexpected things can happen. +</ul> + +<h2>Microsoft Windows</h2> + +Windows 9x (win95, win98, win98SE and winME) has a batch file system which +does not work fully with long file names, so we recommend that ant and the JDK +are installed into directories without spaces, and with 8.3 filenames. +The Perl and Python launcher scripts do not suffer from this limitation. + +<p> +All versions of windows are usually case insensitive, although mounted +file systems (Unix drives, Clearcase views) can be case sensitive underneath, +confusing patternsets. + +<p> +Ant can often not delete a directory which is open in an Explorer window. +There is nothing we can do about this short of spawning a program to kill +the shell before deleting directories. + +<h2>Apple MacOS X</h2> + +MacOS X is the first of the Apple platforms that Ant supports completely; +it is treated like any other Unix. + +<h2>Novell Netware</h2> + +<h2>Other platforms</h2> +Support for other platforms is not guaranteed to be complete, as certain +techniques to hide platform details from build files need to be written and +tested on every particular platform. Contributions in this area are welcome. + +</html> diff --git a/docs/manual/toc.html b/docs/manual/toc.html index 8e254ae43..40d4555c7 100644 --- a/docs/manual/toc.html +++ b/docs/manual/toc.html @@ -20,7 +20,8 @@ <a href="developlist.html" target="navFrame">Developing with Ant</a><br> <a href="api/index.html" target="_top">Ant API</a><br> <a href="LICENSE">License</a><br> -<a href="feedback.html">Feedback</a><br><br> +<a href="feedback.html">Feedback and Troubeshooting</a><br> +<br> <a href="credits.html">Authors</a><br> </body>