You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/05/07 13:04:38 UTC
svn commit: r1794195 - in /maven/shared/trunk/maven-artifact-transfer:
pom.xml src/site/apt/index.apt.vm src/site/apt/install-project.apt
src/site/site.xml
Author: khmarbaise
Date: Sun May 7 13:04:38 2017
New Revision: 1794195
URL: http://svn.apache.org/viewvc?rev=1794195&view=rev
Log:
Improved documentation a little bit.
o Changed description in pom.
o Added some parts as documentation.
Added:
maven/shared/trunk/maven-artifact-transfer/src/site/apt/index.apt.vm
maven/shared/trunk/maven-artifact-transfer/src/site/apt/install-project.apt
Modified:
maven/shared/trunk/maven-artifact-transfer/pom.xml
maven/shared/trunk/maven-artifact-transfer/src/site/site.xml
Modified: maven/shared/trunk/maven-artifact-transfer/pom.xml
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/pom.xml?rev=1794195&r1=1794194&r2=1794195&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/pom.xml (original)
+++ maven/shared/trunk/maven-artifact-transfer/pom.xml Sun May 7 13:04:38 2017
@@ -31,7 +31,7 @@
<version>0.9.1-SNAPSHOT</version>
<name>Apache Maven Artifact Transfer</name>
- <description>An API to install, deploy and resolving artifacts with Maven3</description>
+ <description>An API to install, deploy and resolving artifacts with Maven 3</description>
<scm>
<connection>scm:svn:http://svn.apache.org/repos/asf/maven/shared/trunk/maven-artifact-transfer</connection>
Added: maven/shared/trunk/maven-artifact-transfer/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/site/apt/index.apt.vm?rev=1794195&view=auto
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/site/apt/index.apt.vm (added)
+++ maven/shared/trunk/maven-artifact-transfer/src/site/apt/index.apt.vm Sun May 7 13:04:38 2017
@@ -0,0 +1,46 @@
+ -----
+ Introduction
+ -----
+ Karl Heinz Marbaise
+ -----
+ 2017-05-07
+ -----
+
+ ~~ 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+${project.name}
+
+ The Maven Artifact Transfer Component is intended as an API
+ to install, deploy and resolving artifacts in Maven 3.
+
+ The {{{./comparison.html} comparison will show }} the differences between
+ a dependency, 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
+ 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
+ change.
+
+
+
Added: maven/shared/trunk/maven-artifact-transfer/src/site/apt/install-project.apt
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/site/apt/install-project.apt?rev=1794195&view=auto
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/site/apt/install-project.apt (added)
+++ maven/shared/trunk/maven-artifact-transfer/src/site/apt/install-project.apt Sun May 7 13:04:38 2017
@@ -0,0 +1,57 @@
+ -----
+ Install Project
+ -----
+ Karl Heinz Marbaise
+ -----
+ 2017-05-07
+ -----
+
+ ~~ 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Install a Project
+
+ If you are developing a maven plugin 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.
+
++---
+ @Parameter ( defaultValue = "${session}", required = true, readonly = true)
+ private MavenSession session;
+ @Parameter ( defaultValue = "${project}", required = true, readonly = true)
+ private MavenProject project;
+
+ @Component
+ private ProjectInstaller installer;
+ ...
+ public void execute() {
+
+ ProjectInstallerRequest pir =
+ new ProjectInstallerRequest()
+ .setProject( project ).setUpdateReleaseInfo( updateReleaseInfo );
+
+ installer.install( session.getProjectBuildingRequest(), pir );
+ ...
+ }
+
++---
+
+
+
\ No newline at end of file
Modified: maven/shared/trunk/maven-artifact-transfer/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/site/site.xml?rev=1794195&r1=1794194&r2=1794195&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/site/site.xml (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/site/site.xml Sun May 7 13:04:38 2017
@@ -33,6 +33,7 @@ under the License.
</menu>
<menu name="References">
<item name="Dependency vs Artifact vs MavenProject" href="comparison.html"/>
+ <item name="Install a Project" href="install-project.html"/>
</menu>
<menu ref="parent"/>