From 43beb52651974580c42bc907c9f2256681124450 Mon Sep 17 00:00:00 2001 From: bwalding Date: Sun, 29 Jun 2003 13:16:02 +0000 Subject: [PATCH] Cleanup of doco by request. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113543 13f79535-47bb-0310-9956-ffa450edef68 --- ...uthentification.xml => authentication.xml} | 4 +- artifact/xdocs/examples.xml | 8 ++-- artifact/xdocs/index.xml | 9 ++-- artifact/xdocs/navigation.xml | 5 ++- artifact/xdocs/properties.xml | 20 ++++----- artifact/xdocs/protocols.xml | 10 ++--- artifact/xdocs/security.xml | 6 +-- artifact/xdocs/tags.xml | 41 ++++++++++--------- 8 files changed, 53 insertions(+), 50 deletions(-) rename artifact/xdocs/{authentification.xml => authentication.xml} (70%) diff --git a/artifact/xdocs/authentification.xml b/artifact/xdocs/authentication.xml similarity index 70% rename from artifact/xdocs/authentification.xml rename to artifact/xdocs/authentication.xml index 26eb9ff1..8ae3c6b9 100644 --- a/artifact/xdocs/authentification.xml +++ b/artifact/xdocs/authentication.xml @@ -2,12 +2,12 @@ - Maven Artifact Plugin Properties + Authentication Michal Maczka -
+

In preparation

diff --git a/artifact/xdocs/examples.xml b/artifact/xdocs/examples.xml index 2d0df271..dd4cd0d7 100644 --- a/artifact/xdocs/examples.xml +++ b/artifact/xdocs/examples.xml @@ -2,7 +2,7 @@ - Maven Artifact Plug-in Examples + Examples Tim Anderson @@ -10,7 +10,7 @@

The following example demonstrates how to depoyment - of artifact to remote repsoitories can be configured. + of artifact to remote repositories can be configured. - Maven Artifact Plugin Properties + Overview Michal Maczka

- +

- This plugin generates java sources from schemas using Castor. + This plugin allows a client program / user to upload artifacts to a remote + repository using a variety of different protocols.

diff --git a/artifact/xdocs/navigation.xml b/artifact/xdocs/navigation.xml index 1872e547..10eb9352 100644 --- a/artifact/xdocs/navigation.xml +++ b/artifact/xdocs/navigation.xml @@ -8,13 +8,14 @@ - + + - + diff --git a/artifact/xdocs/properties.xml b/artifact/xdocs/properties.xml index fa3e15bf..ff80a25e 100644 --- a/artifact/xdocs/properties.xml +++ b/artifact/xdocs/properties.xml @@ -2,7 +2,7 @@ - Maven Artifact Plugin Properties + Properties Michal Maczka @@ -50,29 +50,29 @@ @@ -88,10 +88,10 @@ diff --git a/artifact/xdocs/protocols.xml b/artifact/xdocs/protocols.xml index d6104907..d80f9c5a 100644 --- a/artifact/xdocs/protocols.xml +++ b/artifact/xdocs/protocols.xml @@ -2,7 +2,7 @@ - Maven Artifact Plugin Properties + Protocols Michal Maczka @@ -32,7 +32,7 @@ - + - + - + @@ -57,7 +57,7 @@ - + diff --git a/artifact/xdocs/security.xml b/artifact/xdocs/security.xml index 8316310f..b1f42c5f 100644 --- a/artifact/xdocs/security.xml +++ b/artifact/xdocs/security.xml @@ -2,12 +2,12 @@ - Maven Artifact Plug-in Examples - Tim Anderson + Security Considerations + Michal Maczka -
+

- Maven Castor Plug-in Tags - Tim Anderson + Tags + Michal Maczka @@ -19,11 +19,11 @@

DocumentDescription
Properties - The behavior of the Maven Artifact Plug-in can be altered via + The behavior of the Maven Artifact Plugin can be altered via several properties. This document describes each property available, and the default used.
maven.repo.x.directory - The path at remote file system where artifacts will be put + The path on the remote file system where artifacts will be placed No
maven.repo.x.username - The user name which will be used to authetificated - user if access to repository requires authentification. + The user name that will be used to authenticated + user if access to repository requires authentication. Yes
maven.repo.x.password - The password which will be used to authetificate + The password which will be used to authenticate user.
- If server/protocol supports authetification via + If server/protocol supports authentication via both private/public keys and password, - first will try to use keys for authentication + it will first try to use keys for authentication and if that doesn't work then - we fall back to using the username and password + will fall back to using the username and password
Yes
maven.repo.x.privatekey - The absoluth path to private key file. + The absolute path to private key file.
Thie is used only for when protocol - supports authetification via private/public + supports authetication via private/public key pair.
YesOptional Optional OptionalOptional (deafult is 22)Optional (default is 22)
@@ -42,11 +42,11 @@ sftp:// Mandatory MandatoryMandatory if private key unless private key is providedMandatory unless private key is provided Optional Optional OptionalOptional (deafult is 22)Optional (default is 22)
FTPNot supported Not supported Not supportedOptional (deafult is 21)Optional (default is 21)
FILE
- + - + @@ -68,13 +68,13 @@
NameDescription
artifact:delpoyartifact:deploy Deploy artifact to remote repository(ies)
artifact:delpoy-snapshotartifact:deploy-snapshot Deploy snapshot version of artifact to remote repository
The project (POM) which produced artifact which will be deployed.
- POM contatins a bunch of settings (variables and context properties) - which must be conulted in order to deploy artifact to repsoitories(s). - Those settings include: + The POM contains settings (variables and context properties) + that must be consulted in order to deploy artifact to a repository. + These settings include:
  1. List of remote repositories where artifact will be deployed
  2. artifactId, groupId, version
  3. -
  4. Individual settings of each repository
  5. +
  6. Individual settings for each repository
  7. Proxy server settings
  8. ...
@@ -96,8 +96,8 @@
  • MD5 checksum file of this file
  • ${artifactId}-snapshot-version
  • - For exaple for artifact with artifactId = foo - the following files will be transfered to the remote repository: + For example for artifact with artifactId = foo + the following files will be transferred to the remote repository:
    • foo-20030620.124616.jar
    • foo-20030620.124616.jar.md5
    • @@ -107,11 +107,11 @@
    File foo-snapshot-version - simply contains the version number (20030620.124616) - that the snapshot is linked with, + contains the version number (20030620.124616) + that the snapshot is linked to, so that 'convert-snapshots' - can correctly update dependencies in projects which will use this artifact. + can correctly update dependencies in projects that will use this artifact.
    artifact:deploy-snapshot tag uses the same set of attributes as artifact:deploy tag @@ -128,19 +128,20 @@

    - Why I should use artifact:install when it is so easy - just to copy a file inside my plugin? + Why should I use artifact:install when it is so easy + to copy a file inside my plugin?
    There are few good reason for that:

    • - What is simple now, not necesserly must stay simple in the future. - E.g. when Maven will run in client-server mode + Although simple now, it will not necessarily remain that way + in the future. + e.g. When Maven runs in client-server mode information about repository content can be cached - and even some files from repository can cached in memory - (e.g. POMS). Using centralized "proxy" which copies - files to the repository can play importand role in this + and some files from the repository can be cached in memory + (e.g. POMS). Using a centralized "proxy" which copies + files to the repository can play important role in this process.