Author: dennisl
Date: Sat Jul 22 16:18:49 2006
New Revision: 424646
URL: http://svn.apache.org/viewvc?rev=424646&view=rev
Log:
[MONE-4] Review Plugin Documentation
Added:
maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt (with props)
maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt (contents,
props changed)
- copied, changed from r423623,
maven/plugins/trunk/maven-one-plugin/src/site/apt/introduction.apt
Removed:
maven/plugins/trunk/maven-one-plugin/src/site/apt/introduction.apt
Modified:
maven/plugins/trunk/maven-one-plugin/pom.xml
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOnePluginMojo.java
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryDeployMojo.java
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryInstallMojo.java
maven/plugins/trunk/maven-one-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-one-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/pom.xml?rev=424646&r1=424645&r2=424646&view=diff
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-one-plugin/pom.xml Sat Jul 22 16:18:49 2006
@@ -2,13 +2,16 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-one-plugin</artifactId>
<packaging>maven-plugin</packaging>
<name>Maven 1.x Plugin</name>
<version>1.1-SNAPSHOT</version>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<issueManagement>
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MONE</url>
Modified:
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOnePluginMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOnePluginMojo.java?rev=424646&r1=424645&r2=424646&view=diff
==============================================================================
---
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOnePluginMojo.java
(original)
+++
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOnePluginMojo.java
Sat Jul 22 16:18:49 2006
@@ -29,7 +29,7 @@
import java.io.File;
/**
- * Create a Maven 1.x plugin.
+ * Package a Maven 1 plugin.
*
* @goal maven-one-plugin
* @phase package
@@ -87,10 +87,13 @@
/**
* @component
+ * @todo Write Javadoc for this
*/
private MavenProjectHelper projectHelper;
/**
+ * Directory that contains the compiled classes to include in the jar.
+ *
* @parameter expression="${project.build.outputDirectory}"
* @required
*/
Modified:
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryDeployMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryDeployMojo.java?rev=424646&r1=424645&r2=424646&view=diff
==============================================================================
---
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryDeployMojo.java
(original)
+++
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryDeployMojo.java
Sat Jul 22 16:18:49 2006
@@ -30,7 +30,7 @@
import org.apache.maven.plugin.MojoExecutionException;
/**
- * Install the artifact in a maven one local repository
+ * Deploy the artifact in a Maven 1 remote repository.
*
* @goal deploy-maven-one-repository
* @phase deploy
@@ -61,27 +61,35 @@
/**
* @component
+ * @todo Write Javadoc for this
*/
protected ArtifactDeployer deployer;
/**
* @component
+ * @todo Write Javadoc for this
*/
protected ArtifactRepositoryFactory factory;
/**
+ * The id to use in <code>settings.xml</code> if you want to configure
server settings there.
+ *
* @parameter expression="${remoteRepositoryId}"
default-value="mavenOneRemoteRepository"
* @required
*/
protected String remoteRepositoryId;
/**
+ * The URL to the remote repository.
+ *
* @parameter expression="${remoteRepositoryUrl}"
* @required
*/
protected String remoteRepositoryUrl;
/**
+ * Whether the remote repository uses a legacy layout or not.
+ *
* @component roleHint="legacy"
*/
private ArtifactRepositoryLayout legacyLayout;
Modified:
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryInstallMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryInstallMojo.java?rev=424646&r1=424645&r2=424646&view=diff
==============================================================================
---
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryInstallMojo.java
(original)
+++
maven/plugins/trunk/maven-one-plugin/src/main/java/org/apache/maven/plugins/mavenone/MavenOneRepositoryInstallMojo.java
Sat Jul 22 16:18:49 2006
@@ -35,7 +35,7 @@
import java.util.Properties;
/**
- * Install the artifact in a maven one local repository
+ * Install the artifact in the Maven 1 local repository.
*
* @goal install-maven-one-repository
* @phase install
@@ -66,20 +66,26 @@
/**
* @component
+ * @todo Write Javadoc for this
*/
protected ArtifactInstaller installer;
/**
* @component
+ * @todo Write Javadoc for this
*/
protected ArtifactRepositoryFactory factory;
/**
+ * The location of the local repository.
+ *
* @parameter expression="${mavenOneRepository}"
*/
protected String mavenOneRepository;
/**
+ * Whether the local repository uses a legacy layout or not.
+ *
* @component roleHint="legacy"
*/
private ArtifactRepositoryLayout legacyLayout;
Added: 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=424646&view=auto
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt Sat Jul 22
16:18:49 2006
@@ -0,0 +1,31 @@
+ ------
+ Introduction
+ ------
+ Dennis Lundberg
+ ------
+ 20 July 2006
+ ------
+
+
+Maven 2 One Plugin
+
+ This plugin provides some integration tasks with Maven 1.x:
+
+ * Provides a packaging mechanism for Maven 1.x plugins, building using
Maven 2.0
+
+ * Provides a hook for installation that will copy built artifacts into a
local or remote Maven 1.x repository, for
+ concurrent development with Maven 1.x projects
+
+* Goals Overview
+
+ * {{{deploy-maven-one-repository-mojo.html}one:deploy-maven-one-repository}}
deploy an artifact into a Maven 1 remote repository.
+
+ *
{{{install-maven-one-repository-mojo.html}one:install-maven-one-repository}}
install an artifact into the Maven 1 local repository.
+
+ * {{{maven-one-plugin-mojo.html}one:maven-one-plugin}} package a Maven 1
plugin.
+
+ []
+
+* Usage
+
+ Instructions on how to use the One Plugin can be found {{{usage.html}here}}.
Propchange: maven/plugins/trunk/maven-one-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Copied: maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt (from
r423623, maven/plugins/trunk/maven-one-plugin/src/site/apt/introduction.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt?p2=maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt&p1=maven/plugins/trunk/maven-one-plugin/src/site/apt/introduction.apt&r1=423623&r2=424646&rev=424646&view=diff
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/apt/introduction.apt
(original)
+++ maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt Sat Jul 22
16:18:49 2006
@@ -6,19 +6,13 @@
1 November 2005
----------
-Maven One Plugin
-
- The Maven One Plugin is a plugin for Maven 2.0 that performs some
integration tasks with Maven 1.x:
-
- * Provides a packaging for Maven 1.x plugins, building using Maven 2.0
-
- * Provides a hook for installation that will copy built artifacts into a
local Maven 1.x repository, for
- concurrent development with Maven 1.x projects
+Usage
* Maven 1.x Plugin Packaging
To build a Maven 1.x plugin using Maven 2.x, you need to include this plugin
in the build section, and use a
- <<<packaging>>> of <<<maven-one-plugin>>>. The following is an example of
such a POM:
+ <<<packaging>>> of <<<maven-one-plugin>>>. The following is an example of
how such a POM would look for the
+ Maven 1.x site plugin:
-------
<project>
@@ -30,6 +24,7 @@
<build>
<plugins>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-one-plugin</artifactId>
<extensions>true</extensions>
</plugin>
@@ -45,7 +40,10 @@
-------
<project>
...
+ <build>
+ <plugins>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-one-plugin</artifactId>
<executions>
<execution>
@@ -55,7 +53,10 @@
</execution>
</executions>
</plugin>
- ...
+ ...
+ </plugins>
+ </build>
+ ...
</project>
-------
@@ -65,18 +66,21 @@
* Maven 1.x Remote Repository Deployment
- To have your artifact deployed into an additional remote Maven 1.x
repository, add the following lifecycle binding to
- your POM:
+ To have your artifact deployed into an additional remote Maven 1.x
repository, you need to add a lifecycle binding to
+ your POM. This example will deploy your artifact to the Maven 1.x repository
at Apache:
-------
<project>
...
+ <build>
+ <plugins>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-one-plugin</artifactId>
<executions>
<execution>
<configuration>
-
<remoteRepositoryUrl>scp://cvs.apache.org/repository</remoteRepositoryUrl>
+
<remoteRepositoryUrl>scp://people.apache.org/repository</remoteRepositoryUrl>
</configuration>
<goals>
<goal>deploy-maven-one-repository</goal>
@@ -84,14 +88,17 @@
</execution>
</executions>
</plugin>
- ...
+ ...
+ </plugins>
+ </build>
+ ...
</project>
-------
This will not read any settings from the Maven 1.x properties, so the URL is
required.
- If configuring server settings in your local configuration, use the ID of
<<<mavenOneRemoteRepository>>>. This can be
- overridden using the <<<remoteRepositoryId>>> configuration element.
+ If you configure server settings in your <<<settings.xml>>> file, use the ID
of <<<mavenOneRemoteRepository>>>.
+ This can be overridden using the <<<remoteRepositoryId>>> configuration
element.
- For more information, see the {{{index.html} Goal Reference}}.
+ For more information, see the {{{plugin-info.html} Goal Reference}}.
Propchange: maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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=424646&r1=424645&r2=424646&view=diff
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-one-plugin/src/site/site.xml Sat Jul 22 16:18:49
2006
@@ -1,6 +1,26 @@
-<project name="Maven One plugin">
+<?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.
+ */
+-->
+
+<project name="Maven One Plugin">
<bannerLeft>
- <name>Maven One plugin</name>
+ <name>Maven One Plugin</name>
<src>http://maven.apache.org/images/apache-maven-project.png</src>
<href>http://maven.apache.org/</href>
</bannerLeft>
@@ -9,11 +29,13 @@
</bannerRight>
<body>
<links>
- <item name="Maven 2" href="http://maven.apache.org"/>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
- <menu name="Maven One Plugin">
- <item name="Introduction" href="introduction.html"/>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
</menu>
${reports}
