You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by jv...@apache.org on 2003/02/13 04:40:14 UTC

cvs commit: jakarta-turbine-maven/xdocs faq.xml

jvanzyl     2003/02/12 19:40:13

  Modified:    xdocs    faq.xml
  Log:
  o Removing dvsl references as it's no longer used.
  o Adding entry about problems generating the site when there are
    conflicting versions of Jelly.
  
  Revision  Changes    Path
  1.22      +220 -169  jakarta-turbine-maven/xdocs/faq.xml
  
  Index: faq.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/xdocs/faq.xml,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- faq.xml	13 Dec 2002 02:12:21 -0000	1.21
  +++ faq.xml	13 Feb 2003 03:40:13 -0000	1.22
  @@ -9,45 +9,51 @@
   
     <body>
   
  -  <section name="Frequently Asked Questions">
  -    <p>
  -      This document attempts to answer some of the more frequently asked
  -      questions regarding various aspects of Maven.  These questions are
  -      typically asked over and over again on the mailing lists, as a
  -      courtesy to the developers, we ask that you read this document
  -      before posting to the mailing lists.  
  -    </p>
  -    <p><strong>General</strong></p>
  -    <ol>
  -      <li>
  -        <a href="#what-is-maven">
  -          What is Maven?
  -        </a>
  -      </li>
  -    </ol>
  -    <p><strong>Using Maven</strong></p>
  -    <ol>
  -      <li>
  -        <a href="#unit-test-14">
  -          Why does <code>maven:test</code> fail under Java 1.4?
  -        </a>
  -      </li>
  -      <li>
  -        <a href="#javadoc-14">
  -          Why does JavaDoc generation fail under Java 1.4?
  -        </a>
  -      </li>
  -       <li>
  -            <a href="#dvsl-resource-not-an-error">
  -            My build fails with <code>unable to find resource
  -            'VM_global_library.vm' in any resource loader</code>. What is this
  +    <section name="Frequently Asked Questions">
  +      <p>
  +        This document attempts to answer some of the more frequently asked
  +        questions regarding various aspects of Maven.  These questions are
  +        typically asked over and over again on the mailing lists, as a
  +        courtesy to the developers, we ask that you read this document
  +        before posting to the mailing lists.
  +      </p>
  +      <p>
  +        <strong>General</strong>
  +      </p>
  +      <ol>
  +        <li>
  +          <a href="#what-is-maven">
  +            What is Maven?
  +          </a>
  +        </li>
  +      </ol>
  +      <p>
  +        <strong>Using Maven</strong>
  +      </p>
  +      <ol>
  +        <li>
  +          <a href="#unit-test-14">
  +            Why does
  +            <code>maven:test</code> fail under Java 1.4?
  +          </a>
  +        </li>
  +        <li>
  +          <a href="#javadoc-14">
  +            Why does JavaDoc generation fail under Java 1.4?
  +          </a>
  +        </li>
  +        <li>
  +          <a href="#dvsl-resource-not-an-error">
  +            My build fails with
  +            <code>unable to find resource
  +              'VM_global_library.vm' in any resource loader</code>. What is this
               error?
  -            </a>
  +          </a>
           </li>
           <li>
  -            <a href="#changelog-no-local-copy">
  +          <a href="#changelog-no-local-copy">
               Why does change log ask me to check out the source code?
  -            </a>
  +          </a>
           </li>
           <li>
             <a href="#using-xdoclet">
  @@ -59,150 +65,195 @@
               Maven takes a long time to load. Is there anyway to speed things ?
             </a>
           </li>
  -    </ol>
  -    <p><strong>Building Maven</strong></p>
  -    <ol>
  -      <li>
  -        <a href="#how-to-build">
  -          How do I build Maven?
  -        </a>
  -      </li>
  -      <li>
  -        <a href="#build-firewall">
  -          How do I build Maven from behind a firewall?
  -        </a>
  -      </li>
  -    </ol>
  -
  -    <section name="General">
  -      <dl>
  -        <dt>
  -          <a name="what-is-maven">
  -            What is Maven?
  +      </ol>
  +      <p>
  +        <strong>Building Maven</strong>
  +      </p>
  +      <ol>
  +        <li>
  +          <a href="#how-to-build">
  +            How do I build Maven?
             </a>
  -        </dt>
  -        <dd>
  -          Please see the <a href="goals.html">Goals</a> and <a
  -          href="features.html">Features</a> documents.
  -        </dd>
  -      </dl>
  -    </section>
  -    <section name="Using Maven">
  -      <dl>
  -        <dt>
  -          <a name="unit-test-14">
  -            Why do the unit tests fail under Java 1.4?
  -          </a>
  -        </dt>
  -        <dd>
  -          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="properties.html#Test Settings">property</a> to 
  -          <code>yes</code>.
  -        </dd>
  -        <dt>
  -          <a name="javadoc-14">
  -            Why does JavaDoc generation fail under Java 1.4?
  +        </li>
  +        <li>
  +          <a href="#build-firewall">
  +            How do I build Maven from behind a firewall?
             </a>
  -        </dt>
  -        <dd>
  -          This is a known problem and we are working to resolve the
  -          issue.
  -        </dd>
  -        <dt>
  -            <a name="dvsl-resource-not-an-error">
  -            My build fails with <code>unable to find resource
  -            'VM_global_library.vm' in any resource loader</code>. What is this
  -            error?
  +        </li>
  +      </ol>
  +      <p>
  +        <strong>Errors</strong>
  +      </p>
  +      <ol>
  +        <li>
  +          <a href="#jelly-site-error">
  +            When I try to generate my site I get something like this:
  +
  +            <pre>
  +              BUILD FAILED
  +              null:58:46:
  +              &lt;x:parse&gt; 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
  +            </pre>
  +
  +          </a>
  +        </li>
  +      </ol>
  +
  +      <section name="General">
  +        <dl>
  +          <dt>
  +            <a name="what-is-maven">
  +              What is Maven?
               </a>
  -        </dt>
  -        <dd>
  -            This is a dvsl message about a missing resource that doesn't really
  -            cause the build to fail. If you see this message, and your build is
  -            not successful, please run your build again with the 
  -            <code>-debug</code> or <code>-verbose</code> options to determine
  -            the build failure.
  -        </dd>
  -        <dt>
  +          </dt>
  +          <dd>
  +            Please see the
  +            <a href="goals.html">Goals</a> and
  +            <a
  +              href="features.html">Features</a> documents.
  +          </dd>
  +        </dl>
  +      </section>
  +      <section name="Using Maven">
  +        <dl>
  +          <dt>
  +            <a name="unit-test-14">
  +              Why do the unit tests fail under Java 1.4?
  +            </a>
  +          </dt>
  +          <dd>
  +            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="properties.html#Test Settings">property</a> to
  +            <code>yes</code>.
  +          </dd>
  +          <dt>
  +            <a name="javadoc-14">
  +              Why does JavaDoc generation fail under Java 1.4?
  +            </a>
  +          </dt>
  +          <dd>
  +            This is a known problem and we are working to resolve the
  +            issue.
  +          </dd>
  +          <dt>
               <a name="changelog-no-local-copy">
  -            Why does change log ask me to check out the source code?
  +              Why does change log ask me to check out the source code?
               </a>
  -        </dt>
  -        <dd>
  +          </dt>
  +          <dd>
               When you run the cvs change log report in maven, you may see an
  -            error occasionally, such as: 
  +            error occasionally, such as:
               <p>
  -                <code>cvs [log aborted]: there is no version here; do 'cvs checkout' first
  -                <br /> ChangeLog found: 5 entries
  -                </code>
  +              <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 
  +            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.
  -        </dd>
  -        <dt>
  -          <a name="using-xdoclet">
  -            How do I use Maven with xdoclet?
  -          </a>
  -        </dt>
  -        <dd>
  -       	  One user's experiences are written up 
  -       	  <a href="http://orinoco.flamefew.net/moatas/archives/000115.html">here</a>.
  -       	  The Maven team are looking to make it as easy as possible to
  -       	  integrate with <a href="http://xdoclet.sourceforge.net/">xdoclet</a>.
  -        </dd>
  -        <dt>
  -          <a name="speeding-maven">
  -            Maven takes a long time to load. Is there anyway to speed things ?
  -          </a>
  -        </dt>
  -        <dd>
  -          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.          
  -        </dd>
  -      </dl>
  -    </section>
  -    <section name="Building Maven">
  -      <dl>
  -        <dt>
  -          <a name="how-to-build">
  -            How do I build Maven?
  -          </a>
  -        </dt>
  -        <dd>
  -          Please see the <a href="./start/bootstrap.html">Bootstrapping</a>
  -          document.
  -        </dd>
  -      </dl>
  -    </section>
  -    <section name="Building Maven">
  -      <dl>
  -        <dt>
  -          <a name="build-firewall">
  -          	How do I build Maven from behind a firewall?
  -          </a>
  -        </dt>
  -        <dd>
  -          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>
  -          <a href="./reference/properties.html">properties</a>.
  -          See the <a href="./reference/user-guide.html#Using Proxies">User Guide</a> for more details.
  -        </dd>
  -      </dl>
  +          </dd>
  +          <dt>
  +            <a name="using-xdoclet">
  +              How do I use Maven with xdoclet?
  +            </a>
  +          </dt>
  +          <dd>
  +            One user's experiences are written up
  +            <a href="http://orinoco.flamefew.net/moatas/archives/000115.html">here</a>.
  +            The Maven team are looking to make it as easy as possible to
  +            integrate with
  +            <a href="http://xdoclet.sourceforge.net/">xdoclet</a>.
  +          </dd>
  +          <dt>
  +            <a name="speeding-maven">
  +              Maven takes a long time to load. Is there anyway to speed things ?
  +            </a>
  +          </dt>
  +          <dd>
  +            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.
  +          </dd>
  +        </dl>
  +      </section>
  +      <section name="Building Maven">
  +        <dl>
  +          <dt>
  +            <a name="how-to-build">
  +              How do I build Maven?
  +            </a>
  +          </dt>
  +          <dd>
  +            Please see the
  +            <a href="./start/bootstrap.html">Bootstrapping</a>
  +            document.
  +          </dd>
  +        </dl>
  +      </section>
  +      <section name="Building Maven">
  +        <dl>
  +          <dt>
  +            <a name="build-firewall">
  +              How do I build Maven from behind a firewall?
  +            </a>
  +          </dt>
  +          <dd>
  +            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>
  +            <a href="./reference/properties.html">properties</a>.
  +            See the
  +            <a href="./reference/user-guide.html#Using Proxies">User Guide</a> for more details.
  +          </dd>
  +        </dl>
  +      </section>
  +      <section name="Errors">
  +        <dl>
  +          <dt>
  +            <a name="jelly-site-error">
  +              When I try to generate my site I get something like this:
  +
  +              <pre>
  +                BUILD FAILED
  +                null:58:46:
  +                &lt;x:parse&gt; 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
  +              </pre>
  +
  +            </a>
  +          </dt>
  +          <dd>
  +            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.
  +          </dd>
  +        </dl>
  +      </section>
       </section>
  -  </section>
  -</body>
  +  </body>
   </document>