Author: dennisl Date: Tue Aug 29 15:27:59 2006 New Revision: 438264 URL: http://svn.apache.org/viewvc?rev=438264&view=rev Log: [MONE-4] Review Plugin Documentation.
o Put in the feedback from reviewers. o Add license where it was missing. Modified: maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml maven/plugins/trunk/maven-one-plugin/src/site/site.xml Modified: maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt?rev=438264&r1=438263&r2=438264&view=diff ============================================================================== --- maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt (original) +++ maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt Tue Aug 29 15:27:59 2006 @@ -6,6 +6,23 @@ 20 July 2006 ------ +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + A POM for a Maven 1.x plugin Here is an example of how a POM for a Maven 1.x plugin would look. This is Modified: maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt?rev=438264&r1=438263&r2=438264&view=diff ============================================================================== --- maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt (original) +++ maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt Tue Aug 29 15:27:59 2006 @@ -6,6 +6,22 @@ 20 July 2006 ------ +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html Maven 2 One Plugin Modified: maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt?rev=438264&r1=438263&r2=438264&view=diff ============================================================================== --- maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt (original) +++ maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt Tue Aug 29 15:27:59 2006 @@ -6,6 +6,23 @@ 1 November 2005 ---------- +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + Usage * Maven 1 to Maven 2 conversion @@ -57,8 +74,8 @@ * Maven 1.x Local Repository Installation - To have your artifact installed into a local Maven 1.x repository, add the - following lifecycle binding to your POM: + To have your artifact installed into a local Maven 1.x repository, you add a + lifecycle binding to your POM using <<<\<executions\>>>>: ------- <project> Modified: maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml?rev=438264&r1=438263&r2=438264&view=diff ============================================================================== --- maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml (original) +++ maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml Tue Aug 29 15:27:59 2006 @@ -1,14 +1,46 @@ <?xml version="1.0"?> + +<!-- + ~ Copyright 2006 The Apache Software Foundation. + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + <faqs id="FAQ" title="Frequently Asked Questions"> - <part id="General"> - <faq id="question1"> - <question>Will this plugin allow me to use Maven 1.x plugins in Maven 2?</question> - <answer> - <p> - No it will not, but it will allow you to package, install and deploy a - Maven 1.x plugin using Maven 2. - </p> - </answer> - </faq> - </part> + <part id="General"> + <faq id="question1"> + <question>Will this plugin allow me to use Maven 1.x plugins in Maven 2?</question> + <answer> + <p> + No it will not, but it will allow you to package, install and deploy a + Maven 1.x plugin using Maven 2. + </p> + </answer> + </faq> + <faq id="question2"> + <question> + What's the difference between <code>one:deploy-maven-one-repository</code> + and <code>deploy:deploy-file</code> with repositoryLayout set to legacy? + </question> + <answer> + <p> + If you'd use <code>deploy:deploy-file</code> then you'd need to + configure the file, groupId, artifactId, version for it, whereas with + this plugin you don't need to configure anything but the repository, + as it gets the rest from the pom. It's more like + <code>deploy:deploy</code> than it is <code>deploy:deploy-file</code>. + </p> + </answer> + </faq> + </part> </faqs> Modified: maven/plugins/trunk/maven-one-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/site.xml?rev=438264&r1=438263&r2=438264&view=diff ============================================================================== --- maven/plugins/trunk/maven-one-plugin/src/site/site.xml (original) +++ maven/plugins/trunk/maven-one-plugin/src/site/site.xml Tue Aug 29 15:27:59 2006 @@ -1,22 +1,20 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <!-- -/* - * Copyright 2005-2006 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ ---> + ~ Copyright 2005-2006 The Apache Software Foundation. + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> <project name="Maven One Plugin"> <bannerLeft>