Author: dkulp
Date: Tue Apr 10 09:27:21 2007
New Revision: 527180
URL: http://svn.apache.org/viewvc?view=rev&rev=527180
Log:
Update FAQ to explain the supplemental data
Modified:
maven/plugins/trunk/maven-remote-resources-plugin/pom.xml
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
maven/plugins/trunk/maven-remote-resources-plugin/src/site/fml/faq.fml
Modified: maven/plugins/trunk/maven-remote-resources-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/pom.xml?view=diff&rev=527180&r1=527179&r2=527180
==============================================================================
--- maven/plugins/trunk/maven-remote-resources-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-remote-resources-plugin/pom.xml Tue Apr 10
09:27:21 2007
@@ -115,6 +115,22 @@
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
+ <configuration>
+ <version>1.0.0</version>
+ <model>src/main/mdo/supplemental-model.mdo</model>
+ </configuration>
+ </execution>
+ <execution>
+ <id>site-docs-supplement</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xdoc</goal>
+ <goal>xsd</goal>
+ </goals>
+ <configuration>
+ <version>1.0.0</version>
+ <model>src/main/mdo/remote-resources.mdo</model>
+ </configuration>
</execution>
<execution>
<id>remote-resources</id>
Modified:
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java?view=diff&rev=527180&r1=527179&r2=527180
==============================================================================
---
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
(original)
+++
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
Tue Apr 10 09:27:21 2007
@@ -52,7 +52,6 @@
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugin.resources.remote.SupplementalDataModel;
import
org.apache.maven.plugin.resources.remote.io.xpp3.SupplementalDataModelXpp3Reader;
import
org.apache.maven.plugin.resources.remote.io.xpp3.RemoteResourcesBundleXpp3Reader;
import org.apache.maven.project.InvalidProjectModelException;
@@ -134,6 +133,7 @@
* data in the file
"${appendedResourcesDirectory}/supplemental-models.xml".
*
* @parameter
+ * @since 1.0-alpha-5
*/
private String[] supplementalModels;
@@ -756,7 +756,7 @@
{
SupplementalData sd = (SupplementalData) i.next();
- Xpp3Dom dom = (Xpp3Dom)sd.getProject();
+ Xpp3Dom dom = (Xpp3Dom) sd.getProject();
Model m = getSupplement( dom );
supplementMap.put( generateSupplementMapKey( m.getGroupId(),
m.getArtifactId() ), m );
Modified: maven/plugins/trunk/maven-remote-resources-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/site/fml/faq.fml?view=diff&rev=527180&r1=527179&r2=527180
==============================================================================
--- maven/plugins/trunk/maven-remote-resources-plugin/src/site/fml/faq.fml
(original)
+++ maven/plugins/trunk/maven-remote-resources-plugin/src/site/fml/faq.fml Tue
Apr 10 09:27:21 2007
@@ -19,19 +19,66 @@
-->
<faqs id="FAQ" title="Frequently Asked Questions">
- <part id="General">
- <faq id="question1">
- <question>Why do I need to use this plugin?</question>
- <answer>
- <p>
- This plugin greatly reduces the pain associated with consistent
packaging concerns across
- a large set of projects, or an entire organization. Any project can
specify the use of a
- remote resource bundle and have the resources incorporated into their
packaging. This means
- that you can create standard settings in a parent POM somewhere in
the project hierarchy and
- have all projects use package common resources in a standard way like
licenses, other legal
- notices and disclaimers, or anything else that may be common.
- </p>
- </answer>
- </faq>
- </part>
+ <part id="General">
+ <faq id="question1">
+ <question>Why do I need to use this plugin?</question>
+ <answer>
+ <p>
+ This plugin greatly reduces the pain associated with consistent
packaging concerns across
+ a large set of projects, or an entire organization. Any project can
specify the use of a
+ remote resource bundle and have the resources incorporated into
their packaging. This means
+ that you can create standard settings in a parent POM somewhere in
the project hierarchy and
+ have all projects use package common resources in a standard way
like licenses, other legal
+ notices and disclaimers, or anything else that may be common.
+ </p>
+ </answer>
+ </faq>
+ <faq id="question2">
+ <question>The generated files have a lot of missing information.
Looking at the poms from
+ the dependencies, the information isn't there either. What can I
do?</question>
+ <answer>
+ <p>
+ There are two solutions:
+ <ol>
+ <li>
+ File bugs with the projects that produced those artifacts to get
them to fix them. Also,
+ file bugs with the
+ <a href="http://jira.codehaus.org/browse/MEV";>Maven
Evangelism</a>
+ project to have the Maven people enhance the metadata in the
repository.
+ </li>
+ <li>
+ Use a supplemental data file. You can create a file that
contains the missing metadata.
+ For example:
+ <source>
+ <supplementalDataModels>
+ <supplements>
+ <supplement>
+ <project>
+ <groupId>com.sun.xml.bind</groupId>
+ <artifactId>jaxb-impl</artifactId>
+ <name>Sun JAXB Reference Implementation Runtime</name>
+ <organization>
+ <name>Sun Microsystems</name>
+ <url>http://www.sun.com/</url>
+ </organization>
+ <licenses>
+ <license>
+ <name>COMMON DEVELOPMENT AND DISTRIBUTION LICENSE
(CDDL) Version 1.0</name>
+ <url>http://www.sun.com/cddl/cddl.html</url>
+ </license>
+ </licenses>
+ </project>
+ </supplement>
+ </supplements>
+ </supplementalDataModels>
+ </source>
+ That location for that file can then be configured into the
supplementalModels configuration for the process mojo. The
+ supplemental information is merged into the information provided
from the repository.
+ </li>
+ </ol>
+ </p>
+
+ </answer>
+ </faq>
+ </part>
</faqs>
