merge upstream
diff --git a/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java b/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
index d9058ae..bf67425 100644
--- a/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
@@ -36,19 +36,22 @@
* appropriate remote repository.
*
* <pre class="java">
- * @Parameter( defaultValue = "${session}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${session}", required = true, readonly = true )
* MavenSession session;
- * @Parameter( defaultValue = "${project}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${project}", required = true, readonly = true )
* MavenProject project;
* ..
* @Component
* ProjectDeployer deployer;
- *
- * ProjectDeployerRequest pdr =
+ * ...
+ * public void execute()
+ * {
+ * ProjectDeployerRequest pdr =
* new ProjectDeployerRequest()
- * .setProject (project);
+ * .setProject( project );
*
- * deployer.deploy (session.getProjectBuildingRequest(), pdr, artifactRepository);
+ * deployer.deploy( session.getProjectBuildingRequest(), pdr, artifactRepository );
+ * }
* </pre>
*
* @param buildingRequest {@link ProjectBuildingRequest}
diff --git a/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java b/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
index 9ad0d02..40e2f63 100644
--- a/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
+++ b/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
@@ -37,19 +37,22 @@
* the appropriate repository.
*
* <pre class="java">
- * @Parameter( defaultValue = "${session}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${session}", required = true, readonly = true )
* private MavenSession session;
- * @Parameter( defaultValue = "${project}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${project}", required = true, readonly = true )
* private MavenProject project;
* ..
* @Component
* private ProjectInstaller installer;
- *
+ * ...
+ * public void execute()
+ * {
* ProjectInstallerRequest pir =
* new ProjectInstallerRequest()
* .setProject( mavenProject );
- *
- * installer.install( session.getProjectBuildingRequest(), pir );
+ *
+ * installer.install( session.getProjectBuildingRequest(), pir );
+ * }
* </pre>
*
* To set a different local repository than the current one in the Maven session, you can inject an instance of the
diff --git a/src/site/apt/comparison.apt.vm b/src/site/apt/comparison.apt
similarity index 74%
rename from src/site/apt/comparison.apt.vm
rename to src/site/apt/comparison.apt
index d8c3010..82113d4 100644
--- a/src/site/apt/comparison.apt.vm
+++ b/src/site/apt/comparison.apt
@@ -1,5 +1,5 @@
-----
- Introduction
+ Comparison: Dependency vs Artifact vs MavenProject
-----
Robert Scholte
-----
@@ -26,24 +26,26 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Comparison
+Comparison: Dependency vs Artifact vs MavenProject
- Here's a small matrix which should help you choosing the right instance.
+ Here's a small matrix which should help you choosing the right instance.
- In general:
+ In general:
- * an Artifact holds a file mapped on a certain coordinate.
+ * an Artifact holds a file mapped on a certain coordinate (GAV + classifier + extension),
- * a Dependency contains an artifact and has transitive information
+ * a {{{/ref/current/maven-model/maven.html#class_dependency}Dependency}} contains an artifact and has transitive information,
- * a MavenProject hold a pom-file and optional mainfile and can have attached (=classified) files, all using the same GAV.
+ * a MavenProject holds a pom-file, an optional main file derived from the packaging, and can have attached files (= with classifier and extension), all using the same GAV.
+
+ []
*--------------------+-------------+----------------+---------------+
|| || Dependency || Artifact || MavenProject ||
*--------------------+-------------+----------------+---------------+
| Has dependencies | yes | no | yes |
*--------------------+-------------+----------------+---------------+
-| filetype reference | type | file-extension | packaging |
+| filetype reference | {{{/ref/current/maven-core/artifact-handlers.html}type}} | file extension | packaging |
*--------------------+-------------+----------------+---------------+
| version ranges | yes | no | no |
*--------------------+-------------+----------------+---------------+
@@ -52,10 +54,8 @@
This implies the following:
- * From dependency to artifact is possible, since you can map a type to an extension.
+ * From dependency to artifact is possible, since you can map a type to an extension.
However, it is not possible to go from artifact back to dependency, there are several types which have jar as file extension.
- * There's no such thing as transitive artifacts. Filtering during resolution as based on DependencyFilters,
+ * There's no such thing as transitive artifacts. Filtering during resolution is based on DependencyFilters,
ArtifactFilters can only be applied afterwards, hence are less efficient.
-
-
diff --git a/src/site/apt/deploy-project.apt b/src/site/apt/deploy-project.apt
index eb3e81d..e145fb4 100644
--- a/src/site/apt/deploy-project.apt
+++ b/src/site/apt/deploy-project.apt
@@ -1,5 +1,5 @@
-----
- Deploy Project
+ Deploy a Project
-----
Karl Heinz Marbaise
-----
@@ -28,27 +28,29 @@
Deploy a Project
- If you are developing a maven plugin you need often to deploy a whole project
- into a repository which is a little bit cumbersome. This can be easily
- done via the following code parts.
+ If you are developing a Maven plugin, you need often to deploy a whole project
+ into a repository, which is a little bit cumbersome.
+
+ With this component, this can be easily done via the following code parts:
+---
- @Parameter ( defaultValue = "${session}", required = true, readonly = true)
+ @Parameter ( defaultValue = "${session}", required = true, readonly = true )
private MavenSession session;
- @Parameter ( defaultValue = "${project}", required = true, readonly = true)
+ @Parameter ( defaultValue = "${project}", required = true, readonly = true )
private MavenProject project;
@Component
private ProjectDeployer deployer;
...
- public void execute() {
+ public void execute()
+ {
- ProjectDeployerRequest pir =
+ ProjectDeployerRequest pdr =
new ProjectDeployerRequest()
//TODO: Think about setUpdateReleaseInfo()..
.setProject( project ).setUpdateReleaseInfo( true );
- deployer.deploy( session.getProjectBuildingRequest(), pir );
+ deployer.deploy( session.getProjectBuildingRequest(), pdr );
...
}
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 7de7423..1c729a6 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -34,11 +34,14 @@
The {{{./comparison.html} comparison shows}} the differences between
a dependency, an artifact, and a Maven project.
- The {{{./install-project.html} install project}} part shows
+ The {{{./install-project.html} install project}} page shows
how to use this component to install artifacts into the local
repository from your plugin's source code.
+ The {{{./deploy-project.html} deploy project}} page shows
+ how to use this component to make a deploy of an existing project.
+
<<Current State Of The Component>>
This shared component has not yet reached 1.0.0 and is not stable.
- The API can change.
+ The API can and likely will change.
diff --git a/src/site/apt/install-project.apt b/src/site/apt/install-project.apt
index ea89575..b9e477e 100644
--- a/src/site/apt/install-project.apt
+++ b/src/site/apt/install-project.apt
@@ -1,5 +1,5 @@
-----
- Install Project
+ Install a Project
-----
Karl Heinz Marbaise
-----
@@ -28,20 +28,22 @@
Install a Project
- If you are developing a maven plugin or other components related to Maven you need
+ If you are developing a Maven plugin or other components related to Maven, you need
often to install artifacts into the local repository which is a little bit cumbersome.
- This can be easily done via the following code parts.
+
+ With this component, this can be easily done via the following code parts:
+---
- @Parameter ( defaultValue = "${session}", required = true, readonly = true)
+ @Parameter ( defaultValue = "${session}", required = true, readonly = true )
private MavenSession session;
- @Parameter ( defaultValue = "${project}", required = true, readonly = true)
+ @Parameter ( defaultValue = "${project}", required = true, readonly = true )
private MavenProject project;
@Component
private ProjectInstaller installer;
...
- public void execute() {
+ public void execute()
+ {
ProjectInstallerRequest pir =
new ProjectInstallerRequest()
diff --git a/src/site/site.xml b/src/site/site.xml
index f46f50e..88fa49e 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -34,6 +34,7 @@
<menu name="References">
<item name="Dependency vs Artifact vs MavenProject" href="comparison.html"/>
<item name="Install a Project" href="install-project.html"/>
+ <item name="Deploy a Project" href="deploy-project.html"/>
</menu>
<menu ref="parent"/>
