This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/maven-artifact-transfer.gitThe following commit(s) were added to refs/heads/master by this push:
new d93f7ca formatting & little typos fixes
d93f7ca is described below
commit d93f7ca42839665b504f463b5e4041a9a129247b
Author: Hervé Boutemy <
[hidden email]>
AuthorDate: Sun Dec 1 14:35:34 2019 +0100
formatting & little typos fixes
---
src/site/apt/deploy-project.apt | 20 +++++++++++---------
src/site/apt/index.apt.vm | 14 +++++++-------
src/site/apt/install-project.apt | 14 ++++++++------
3 files changed, 26 insertions(+), 22 deletions(-)
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 58b281a..1e09ffe 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -28,18 +28,18 @@
${project.name}
- The Maven Artifact Transfer Component is intended as an API
- to install, deploy and resolving artifacts in Maven 3.
+ The Maven Artifact Transfer component is intended as an API
+ to install, deploy and resolve artifacts in Maven 3.
- The {{{./comparison.html} comparison will show }} the differences between
- a dependency, artifact and a maven project.
+ The {{{./comparison.html} comparison}} will show the differences between
+ a dependency, an artifact and a Maven project.
- The {{{./install-project.html} install project}} part will show
- how to this component to make an install of an existing project
+ The {{{./install-project.html} install project}} page will show
+ how to use this component to make an install of an existing project,
which makes the handling within plugins much easier.
<<Current State Of The Component>>
- Currently this shared component has not yet reached the final 1.0.0 version state which means the interfaces can
+ Currently this shared component has not yet reached the final 1.0.0 version state, which means the interfaces can
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()
Locked
