dion 2003/07/16 18:22:31
Modified: xdocs navigation.xml
Added: xdocs faq.fml
Removed: xdocs powered.xml articles.xml tasks.xml glossary.xml
Log:
Reorg and use new faq format
Revision Changes Path
1.24 +14 -14 maven/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/navigation.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- navigation.xml 9 Jul 2003 00:09:42 -0000 1.23
+++ navigation.xml 17 Jul 2003 01:22:31 -0000 1.24
@@ -27,9 +27,9 @@
<item name="Eclipse"
href="/reference/ide/eclipse/index.html"/>
</item>
</item>
- <item name="FAQ" href="/faq.html"/>
+ <item name="FAQ" href="/faq.html"/>
<item name="Project Layout" href="/reference/dirlayout.html"
collapse="true">
- <item name="Site Navigation" href="/site.html"/>
+ <item name="Site Navigation" href="/site.html"/>
</item>
<item name="Ant Guide" href="/ant-guide/index.html"
collapse="true">
<item name="Design" href="/ant-guide/design.html"/>
@@ -42,19 +42,19 @@
<item name="Properties" href="/ant-guide/qna/inprogress.html"/>
</item>
</item>
+ <item name="Maven Wiki" href="http://wiki.codehaus.org/maven/"/>
+ </item>
+ <item name="Misc" href="/misc/index.html" collapse="true">
+ <item name="Articles" href="/misc/articles.html"/>
+ <item name="Glossary" href="/misc/glossary.html"/>
+ <item name="Powered By" href="/misc/powered.html"/>
+ <item name="Tasks" href="/misc/tasks.html"/>
+ </item>
+ <item name="Apache" href="/apache/index.html" collapse="true">
+ <item name="Developer Resources" href="http://www.apache.org/dev/"/>
+ <item name="Web stats"
href="http://www.apache.org/~vgritsenko/stats/projects/maven.html"/>
+ <item name="Apache Wiki"
href="http://nagoya.apache.org/wiki/apachewiki.cgi"/>
</item>
- <item name="Maven Wiki" href="http://wiki.codehaus.org/maven/"/>
- </menu>
- <menu name="Misc">
- <item name="Powered By" href="/powered.html"/>
- <item name="Tasks" href="/tasks.html"/>
- <item name="Glossary" href="/glossary.html"/>
- <item name="Articles" href="/articles.html"/>
- </menu>
- <menu name="Apache">
- <item name="Developer Resources" href="http://www.apache.org/dev/"/>
- <item name="Web stats"
href="http://www.apache.org/~vgritsenko/stats/projects/maven.html"/>
- <item name="Apache Wiki" href="http://nagoya.apache.org/wiki/apachewiki.cgi"/>
</menu>
</body>
</project>
1.1 maven/xdocs/faq.fml
Index: faq.fml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<faqs title="Frequently Asked Questions">
<part id="general">
<title>General</title>
<faq id="what-is-maven">
<question>What is Maven?</question>
<answer>
Please see the <a href="goals.html">Goals</a> and
<a href="features.html">Features</a> documents.
</answer>
</faq>
<faq id="where-get-help">
<question>Where do I get help on Maven?</question>
<answer>
<p>
This FAQ answers some frequent questions already, please read the
<a href="start/">Getting Started</a> for a quick start guide.
</p>
<p>
The <a href="reference/">Reference</a> section contain a comprehensive
user guide and documentation about the various plugins that exist for
maven. Furthermore there's a maven wiki.
(Don't know what that is? Read
<a href="http://wiki.org/wiki.cgi?WhatIsWiki";>What is wiki?</a>)
</p>
<p>
If these resources don't help you with your problem, the
<a href="mail-lists.html">Maven User List</a> is a good source for help.
Lots of problems have already been discussed there, you'll probably find
a solution in the mailling list archive. Most of the maven developers
are subscribed to the Maven User List.
</p>
<p>
Maven developers meet via IRC: <a
href="irc://irc.codehaus.org#maven">irc.codehaus.org:6667</a>,
channel <tt>#maven</tt>
But please don't ask for solutions to maven problems there, as
maven user problems should be discussed at the mailing list
for several good reasons (e.g. mail archive, more subscribers) and
usually you get a quick answer on the mailing list.
</p>
</answer>
</faq>
</part>
<part id="using">
<title>Using Maven</title>
<faq id="unit-test-14">
<question>Why do the unit tests fail under Java 1.4?</question>
<answer>
It is possible that the XML parser included with Ant is
interfering with the XML parser included in Java 1.4. Please set
the <code>${maven.junit.fork}</code>
<a href="reference/plugins/test/properties.html">property</a> to
<code>yes</code>.
</answer>
</faq>
<faq id="javadoc-14">
<question>Why does JavaDoc generation fail under Java 1.4?</question>
<answer>
This is a known problem and we are working to resolve the
issue.
</answer>
</faq>
<faq id="changelog-no-local-copy">
<question>Why does change log ask me to check out the source code?</question>
<answer>
When you run the cvs change log report in maven, you may see an
error occasionally, such as:
<p>
<code>cvs [log aborted]: there is no version here; do 'cvs checkout' first
<br/> ChangeLog found: 5 entries
</code>
</p>
This is caused by the cvs log command finding a directory in it's
repository that you don't have locally. Note: The directory may not
appear on a checkout or update if it is empty in the repository.
Please do a clean checkout of the code and retry the report.
</answer>
</faq>
<faq id="changelog-broken">
<question>I have problems generating the changelog report. Why?</question>
<answer>
<p>
When you run the cvs change log report in maven, the report hangs or the
final output is blank.
</p>
<p>
This is typically caused by the cvs command not running correctly.
The first port of call is to check maven.log, search the file for "SCM"
</p>
<p>
<source>
<![CDATA[
2003-02-26 06:42:04,975 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Working Directory: D:\Data\workspace\maven
2003-02-26 06:42:04,985 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Command Line[0]: cvs
2003-02-26 06:42:04,985 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Command Line[1]: -d
2003-02-26 06:42:04,985 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Command Line[2]: :pserver:[EMAIL PROTECTED]:/home/cvsroot
2003-02-26 06:42:04,985 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Command Line[3]: log
2003-02-26 06:42:04,985 INFO org.apache.maven.changelog.AbstractChangeLogGenerator
- SCM Command Line[4]: -d 2003-01-27
]]>
</source>
</p>
<p>
Try running the command that you find in the log file manually. The
results typically
speak for themselves.
</p>
</answer>
</faq>
<faq id="using-xdoclet">
<question>How do I use Maven with xdoclet?</question>
<answer>
The xdoclet plugin is provided by the xdoclet developers. All questions
about it should be directed to the xdoclet mailing lists.
</answer>
</faq>
<faq id="speeding-maven">
<question>Maven takes a long time to load. Is there anyway to speed things
?</question>
<answer>
There are several things that you can do to accelerate this. First,
you should delete the plugins that you don't use. Some plugins are
platform-specific, so you can safely delete those that are not
intended to run on your platform.
<b>
Some plugins depend on other plugins. Please delete plugins with care.
</b>
Once you are sure that you have all the plugins that you need, you
can use the
<a href="reference/plugins/console/index.html">Console Plugin</a> to
get an interactive shell that will let load Maven once and run as many
goals as you want. On average machines it takes something like
ten seconds to compile and run unit tests, so that you can build often
and test your code often.
</answer>
</faq>
<faq id="ibiblio-repository">
<question>Why is the Maven repository on Ibiblio and not at Apache?</question>
<answer>
There are several reasons why the Maven Repository was setup at
Ibiblio. Ibiblio is a massive archive of almost everything you could
imagine but one of the stated goals of Ibiblio is to "Expand and improve the
distribution
of open source software". There is really no limit to how much we can stuff
in the repository at Ibiblio and it will be archived indefinitely. They have
a lot of bandwith, good redundancy and have a very secure setup. Another
reason
we placed the repository there was that it is Apache policy not to store
any (L)GPL artifacts on our servers. We wanted Maven to work for as many
Java developers as possible so we chose Ibiblio where there is no restriction
on store (L)GPL artifacts. You can find out more about Ibiblio
<a href="http://www.ibiblio.org/about.html";>here</a>.
</answer>
</faq>
<faq id="ignoring-broken-tests">
<question>How do I make my build complete even with broken tests?</question>
<answer>
See the <a href="./reference/plugins/test/properties.html">Test Plugin
Reference</a>.
Most notably, <code>maven.test.skip</code> and
<code>maven.test.failure.ignore</code>.
<b>Heed the warnings!</b>
</answer>
</faq>
</part>
<part id="building">
<title>Building Maven</title>
<faq id="how-to-build">
<question>How do I build Maven?</question>
<answer>
Please see the
<a href="./start/bootstrap.html">Bootstrapping</a>
document.
</answer>
</faq>
<faq id="build-firewall">
<question>How do I build Maven from behind a firewall?</question>
<answer>
You typically need to set your HTTP proxy host and port details so that
Maven can tunnel through your
HTTP Proxy. To do this you typically need to set the
<i>maven.proxy.host</i> and
<i>maven.proxy.port</i> properties.
See the
<a href="./reference/user-guide.html#Using Proxies">User Guide</a> for more
details.
</answer>
</faq>
</part>
<part id="errors">
<title>Errors</title>
<faq id="jelly-site-error">
<question>maven site fails with bizarre Jelly errors, what can I do?</question>
<answer>
When I try to generate my site I get something like this:
<source>
<![CDATA[
BUILD FAILED
null:58:46:
<x:parse> Invalid source argument. Must be a String, Reader,
InputStream or URL. Was type; java.io.File with value:
/home/jvanzyl/js/com.werken/drools/target/jdepend-raw-report.xml
Total time: 12 seconds
]]>
</source>
<p>
This problem has been observed when a version of Jelly used as a
dependency is different than the one distributed with Maven.
<a
href="http://www.ibiblio.org/maven/commons-jelly/jars/commons-jelly-20030211.141339.jar";>This</a>
is the version of Jelly that is distributed with Maven 1.0-beta-8.
If you align your versions of Jelly you should be able to generate
your site. We hope to alleviate these problems with real ClassLoader
isolation using Classworlds.
</p>
</answer>
</faq>
<faq id="bootstrapping-required-here">
<question>I can't seem to build Maven from CVS, what's wrong?</question>
<answer>
We get this question a lot and almost invariably it's due to not
bootstrapping. If you want to build Maven from CVS you <b>must</b>
bootstrap which means you must do this in the top-level directory:
<pre>
ant -f build-bootstrap.xml
</pre>
</answer>
</faq>
</part>
<!--
<faq id="">
<question></question>
<answer>
</answer>
</faq>
-->
</faqs>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
