Author: fgiust
Date: Sun Jan 7 10:49:09 2007
New Revision: 493805
URL: http://svn.apache.org/viewvc?view=rev&rev=493805
Log:
improving documentation (usage and examples document are still a todo)
Added:
maven/plugins/trunk/maven-repository-plugin/src/site/apt/
maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt
(with props)
maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt (with
props)
maven/plugins/trunk/maven-repository-plugin/src/site/fml/
maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml
Modified:
maven/plugins/trunk/maven-repository-plugin/pom.xml
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundleCreateMojo.java
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundlePackMojo.java
maven/plugins/trunk/maven-repository-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-repository-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/pom.xml?view=diff&rev=493805&r1=493804&r2=493805
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-repository-plugin/pom.xml Sun Jan 7 10:49:09 2007
@@ -32,6 +32,9 @@
<packaging>maven-plugin</packaging>
<name>Maven Repository Plugin</name>
<version>2.1-SNAPSHOT</version>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<issueManagement>
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MREPOSITORY</url>
Modified:
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundleCreateMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundleCreateMojo.java?view=diff&rev=493805&r1=493804&r2=493805
==============================================================================
---
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundleCreateMojo.java
(original)
+++
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundleCreateMojo.java
Sun Jan 7 10:49:09 2007
@@ -28,7 +28,7 @@
import org.codehaus.plexus.util.StringUtils;
/**
- * Goal which touches a timestamp file.
+ * Goal which creates an upload bundle for a project built with maven.
*
* @goal bundle-create
* @execute phase="package"
@@ -40,22 +40,29 @@
public static final String POM = "pom.xml";
/**
+ * Base directory.
* @parameter expression="${basedir}"
*/
private String basedir;
/**
+ * The current maven project.
* @parameter expression="${project}"
*/
private MavenProject project;
/**
- * @parameter
expression="${component.org.codehaus.plexus.archiver.Archiver#jar}"
+ * Jar archiver.
+ * @parameter
expression="{component.org.codehaus.plexus.archiver.Archiver#jar}"
+ * @required
+ * @readonly
*/
private JarArchiver jarArchiver;
/**
- * @parameter
expression="${component.org.apache.maven.artifact.handler.manager.ArtifactHandlerManager}"
+ * @component
role="org.apache.maven.artifact.handler.manager.ArtifactHandlerManager"
+ * @required
+ * @readonly
*/
private ArtifactHandlerManager artifactHandlerManager;
Modified:
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundlePackMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundlePackMojo.java?view=diff&rev=493805&r1=493804&r2=493805
==============================================================================
---
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundlePackMojo.java
(original)
+++
maven/plugins/trunk/maven-repository-plugin/src/main/java/org/apache/maven/plugins/repository/BundlePackMojo.java
Sun Jan 7 10:49:09 2007
@@ -57,7 +57,10 @@
public static final String POM = "pom.xml";
/**
- * @parameter
expression="${component.org.codehaus.plexus.archiver.Archiver#jar}"
+ * Jar archiver.
+ * @parameter
expression="{component.org.codehaus.plexus.archiver.Archiver#jar}"
+ * @required
+ * @readonly
*/
protected JarArchiver jarArchiver;
@@ -90,25 +93,31 @@
/**
* @component
+ * @required
+ * @readonly
*/
protected InputHandler inputHandler;
/**
+ * Directory where the upload-bundle will be created.
* @parameter expression="${basedir}"
*/
protected String basedir;
/**
+ * GroupId for the artifact to create an upload bundle for.
* @parameter expression="${groupId}"
*/
protected String groupId;
/**
+ * ArtifactId for the artifact to create an upload bundle for.
* @parameter expression="${artifactId}"
*/
protected String artifactId;
/**
+ * Version for the artifact to create an upload bundle for.
* @parameter expression="${version}"
*/
protected String version;
Added: maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt?view=auto&rev=493805
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt (added)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt Sun
Jan 7 10:49:09 2007
@@ -0,0 +1,10 @@
+ ------
+ Examples
+ ------
+ Fabrizio Giustina
+ ------
+ 6 January 2007
+ ------
+
+Maven Repository Plugin: Examples
+
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/example.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt?view=auto&rev=493805
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt (added)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt Sun Jan
7 10:49:09 2007
@@ -0,0 +1,10 @@
+ ------
+ Usage
+ ------
+ Fabrizio Giustina
+ ------
+ 6 January 2007
+ ------
+
+Maven Repository Plugin: Usage
+
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml?view=auto&rev=493805
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml Sun Jan 7
10:49:09 2007
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="including-sources">
+ <question>How can I create an upload bundle containing sources and
javadoc for a project?</question>
+ <answer>
+ <p>You can do that by running the javadoc:jar and sources:jar goals
before repository:bundle-create:</p>
+ <p>
+ <code>mvn sources:jar javadoc:jar repository:bundle-create</code>
+ </p>
+ </answer>
+ </faq>
+ <faq id="bundle-pack">
+ <question>How can I create an upload bunde for a project that I don't
build using maven?</question>
+ <answer>
+ <p>
+ You can manually add the artifact to your local repository, creating
a pom and optionally adding source and
+ javadoc jars. Then you can run "mvn repository:bundle-pack" that
will prompt you for groupId, artifactId and
+ version and generate a bundle you can use for an upload request.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Modified: maven/plugins/trunk/maven-repository-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/site.xml?view=diff&rev=493805&r1=493804&r2=493805
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/site.xml Sun Jan 7
10:49:09 2007
@@ -1,31 +1,31 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-
-<!--
-/*
- * Copyright 2001-2005 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.
- */
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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>
<body>
<menu name="Overview">
- <item name="Introduction" href="index.html"/>
- <item name="Goals" href="plugin-info.html"/>
- <item name="Usage" href="usage.html"/>
- <item name="FAQ" href="faq.html"/>
+ <item name="Introduction" href="index.html" />
+ <item name="Goals" href="plugin-info.html" />
+ <item name="Usage" href="usage.html" />
+ <item name="Examples" href="example.html" />
+ <item name="FAQ" href="faq.html" />
</menu>
- <!-- TODO: examples -->
</body>
</project>
