brett 2004/09/28 02:18:28
Modified: xdocs Tag: MAVEN-1_0-BRANCH faq.fml
xdocs/reference/developers Tag: MAVEN-1_0-BRANCH
releasing-plugins.xml
Log:
faq and plugin release doco updates
Revision Changes Path
No revision
No revision
1.5.4.7 +146 -103 maven/xdocs/faq.fml
Index: faq.fml
===================================================================
RCS file: /home/cvs/maven/xdocs/faq.fml,v
retrieving revision 1.5.4.6
retrieving revision 1.5.4.7
diff -u -r1.5.4.6 -r1.5.4.7
--- faq.fml 27 Jun 2004 11:08:05 -0000 1.5.4.6
+++ faq.fml 28 Sep 2004 09:18:28 -0000 1.5.4.7
@@ -40,9 +40,7 @@
<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>)
+ maven.
</p>
<p>
If these resources don't help you with your problem, the
@@ -61,77 +59,27 @@
</p>
</answer>
</faq>
+
+ <faq id="maven-definition">
+ <question>What does Maven mean?</question>
+ <answer>A maven (yi.=meyvn) is an experienced or knowledgeable person, such
as an expert or freak.</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>
+ <faq id="plugin-docs">
+ <question>How do I find help on a specific goal?</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's output, search the lines
containing for "SCM"
- </p>
- <p>
- <source>
-<![CDATA[
-SCM Working Directory: D:\Data\workspace\maven
-SCM Command Line[0]: cvs
-SCM Command Line[1]: -d
-SCM Command Line[2]: :pserver:[EMAIL PROTECTED]:/home/cvsroot
-SCM Command Line[3]: log
-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.
+ All Maven goals are provided by plugins. For example, the goals
<code>jar</code> and <code>jar:install</code>
+ are provided by the <a href="reference/plugins/jar/index.html">jar
plugin</a>. You can find a list of
+ plugins and there documentation <a
href="reference/plugins/index.html">here</a>.
</p>
</answer>
</faq>
-
+
<faq id="using-xdoclet">
<question>How do I use Maven with xdoclet?</question>
<answer>
@@ -192,39 +140,53 @@
</answer>
</faq>
- <faq id="BadXSLT">
- <question>How do I get the XSLT tasks to work?</question>
+ <faq id="find-junit-messages">
+ <question>Where does the output from my JUnit tests go?</question>
+ <answer>
+ If you are running <code>test:test</code>, the exceptions will usually be
output to
+ <code>./target/test-reports/some.package.SomeClassTest.txt</code>.
+ If you want to see the errors in the output, set the property
<code>maven.junit.usefile</code> to
+ <code>false</code>.
+ </answer>
+ </faq>
+
+ <faq id="multiple-source-directories">
+ <question>How do I provide multiple source directories in my
project.xml?</question>
+ <answer>
+ <p>You can't. However, if you really need it, you can use a snippet in
maven.xml:</p>
+<source><![CDATA[<preGoal name="java:compile">
+ <ant:path
+ id="my.other.src.dir"
+ location="${basedir}/debug/src"/>
+ <maven:addPath
+ id="maven.compile.src.set"
+ refid="my.other.src.dir"/>
+</preGoal>]]></source>
+ <p>Please think about the reason you need this, and carefully consider
whether it is necessary. Usually this
+ is used for writing plugins that handle source generation.</p>
+ </answer>
+ </faq>
+
+ <faq id="multiple threads">
+ <question>How do I spin off a background process in a goal?</question>
<answer>
<p>
- A common symptom is that the Jelly or Ant tag are output instead of being
processed.
- See <a
href="http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-156";>MAVEN-156</a>.
- </p>
- <p>
- The solution is to add the JAXP system property via the Jelly script.
+ For example, before starting unit tests you might need to start a DB
server. The DB server blocks until it is
+ terminated, so it needs to be started in the background.
<code><ant:parallel></code> does not seem to
+ work in this case because it blocks the main execution thread, which is
exactly what needs to be avoided.
</p>
- <source><![CDATA[
-${systemScope.setProperty('javax.xml.transform.TransformerFactory','org.apache.xalan.processor.TransformerFactoryImpl')}
-<ant:style in="${basedir}/some.xml" out="${maven.build.dest}/other.xml"
style="${basedir}/sheet.xsl" processor="trax"/>
-]]></source>
<p>
- Also make sure that Xalan is declared as dependencies in your project
file:
+ The solution is given in
+ <a href="http://nagoya.apache.org/eyebrowse/[EMAIL
PROTECTED]&msgId=812534">this
+ thread</a>.
</p>
- <source><![CDATA[
-<dependency>
- <groupId>xalan</groupId>
- <artifactId>xalan</artifactId>
- <version>2.3.1</version>
- <url>http://xml.apache.org/xalan/</url>
-</dependency>
- ]]></source>
</answer>
</faq>
+
<faq id="DownloadPlugin">
<question>How to download a new plugin</question>
<answer>
- <source>
-maven -DartifactId=artifactID -DgroupID=GROUPID -Dversion=VERSION plugin:download
- </source>
+ <source>maven -DartifactId=artifactID -DgroupId=GROUPID -Dversion=VERSION
plugin:download</source>
</answer>
</faq>
</part>
@@ -275,10 +237,104 @@
</answer>
</faq>
</part>
-
- <part id="errors">
- <title>Errors</title>
+
+ <part id="troubleshooting">
+ <title>Troubleshooting 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's output, search the lines
containing for "SCM"
+ </p>
+ <p>
+ <source>
+<![CDATA[
+SCM Working Directory: D:\Data\workspace\maven
+SCM Command Line[0]: cvs
+SCM Command Line[1]: -d
+SCM Command Line[2]: :pserver:[EMAIL PROTECTED]:/home/cvsroot
+SCM Command Line[3]: log
+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="BadXSLT">
+ <question>How do I get the XSLT tasks to work?</question>
+ <answer>
+ <p>
+ A common symptom is that the Jelly or Ant tag are output instead of being
processed.
+ See <a
href="http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-156";>MAVEN-156</a>.
+ </p>
+ <p>
+ The solution is to add the JAXP system property via the Jelly script.
+ </p>
+ <source><![CDATA[
+${systemScope.setProperty('javax.xml.transform.TransformerFactory','org.apache.xalan.processor.TransformerFactoryImpl')}
+<ant:style in="${basedir}/some.xml" out="${maven.build.dest}/other.xml"
style="${basedir}/sheet.xsl" processor="trax"/>
+]]></source>
+ <p>
+ Also make sure that Xalan is declared as dependencies in your project
file:
+ </p>
+ <source><![CDATA[
+<dependency>
+ <groupId>xalan</groupId>
+ <artifactId>xalan</artifactId>
+ <version>2.3.1</version>
+ <url>http://xml.apache.org/xalan/</url>
+</dependency>
+ ]]></source>
+ </answer>
+ </faq>
+
<faq id="jelly-site-error">
<question>maven site fails with bizarre Jelly errors, what can I
do?</question>
<answer>
@@ -303,19 +359,6 @@
</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>
<part id="recent-changes">
No revision
No revision
1.4.4.7 +16 -2 maven/xdocs/reference/developers/releasing-plugins.xml
Index: releasing-plugins.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/developers/releasing-plugins.xml,v
retrieving revision 1.4.4.6
retrieving revision 1.4.4.7
diff -u -r1.4.4.6 -r1.4.4.7
--- releasing-plugins.xml 8 Jul 2004 08:29:01 -0000 1.4.4.6
+++ releasing-plugins.xml 28 Sep 2004 09:18:28 -0000 1.4.4.7
@@ -53,9 +53,23 @@
</ul>
</section>
<section name="Releasing Maven plugins">
+ <p>
+ Prerequesites: you must define the following properties in
<code>~/build.properties</code>. (Note: you may
+ want to put these in
<code>maven-plugins/plugin-parent/build.properties</code> instead if you need to define
+ them differently for other projects).
+ </p>
+ <ul>
+ <li><code>maven.repo.apache.username</code> - your apache username</li>
+ <li><code>maven.repo.apache.privatekey</code> - the filename of your SSH
private key</li>
+ <li><code>maven.repo.apache.passphrase</code> - the passphrase for your
private key (<b>not</b> your Apache password)</li>
+ <li><code>maven.announcement.mail.from</code> - Your name and email address,
as subscribed to the users and
+ developers mailing lists, e.g. <code>Brett Porter <[EMAIL
PROTECTED]></code></li>
+ <li><code>maven.announcement.mail.server</code> - The SMTP server to use for
sending the announcement mail.</li>
+ </ul>
+ <p>Release process</p>
<ul>
<li>
- <p>Run maven scm:prepare-release and enter the appropriate tag
+ <p>Run <code>maven scm:prepare-release</code> and enter the appropriate tag
(<code>MAVEN_[PROJECTNAME]_[MAJOR]_[MINOR]</code>) and version. This will
update the
<code>currentVersion</code>, <code>versions</code> entries, and
<code>xdocs/changes.xml</code> file
with the new version and release date. It will also commit your
<code>project.xml</code> and
@@ -82,7 +96,7 @@
</p>
</li>
<li>
- <p>Run <code>maven announcement</code>. Edit this, then send it in a
release email to the Maven user and developer lists.
+ <p>Run <code>maven announcement</code>. Edit this, then send it in a
release email to the Maven user and developer lists. If you are happy with the default
announcement, run <code>maven announcement:mail</code>.
</p>
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
