mirror of https://github.com/apache/maven.git
minor updates, remove outdated doco
git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@193112 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
b796b7635a
commit
539658eefa
|
@ -1,15 +0,0 @@
|
||||||
-----
|
|
||||||
Bootstrapping
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Installing maven2
|
|
||||||
|
|
||||||
* Download m2 {{{http://www.apache.org/~jvanzyl/m2/m2.tgz}here}}.
|
|
||||||
|
|
||||||
* Unpack in your home directory. In will expand in a directory called <<<m2>>>.
|
|
||||||
|
|
||||||
* Put ~/m2/bin in your path.
|
|
||||||
|
|
||||||
* Run m2! i.e. <<<m2 jar:jar>>>.
|
|
|
@ -1,9 +0,0 @@
|
||||||
-----
|
|
||||||
FAQ
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Maven2
|
|
||||||
|
|
||||||
This is maven2. Dig it.
|
|
|
@ -1,9 +0,0 @@
|
||||||
-----
|
|
||||||
Maven2
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Maven2
|
|
||||||
|
|
||||||
This is maven2. Dig it.
|
|
|
@ -1,26 +0,0 @@
|
||||||
-----
|
|
||||||
Installing maven2
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Installing maven2
|
|
||||||
|
|
||||||
*
|
|
||||||
|
|
||||||
|
|
||||||
* Download m2 {{{http://www.apache.org/~jvanzyl/m2/m2.tgz}here}}.
|
|
||||||
|
|
||||||
* Unpack in your home directory. In will expand in a directory called <<<m2>>>.
|
|
||||||
|
|
||||||
* Put ~/m2/bin in your path.
|
|
||||||
|
|
||||||
* Run m2! i.e. <<<m2 jar:jar>>>.
|
|
||||||
|
|
||||||
* Notes
|
|
||||||
|
|
||||||
* Is M2_HOME required?
|
|
||||||
|
|
||||||
* Format of override needed
|
|
||||||
|
|
||||||
* All the m2 POMs are missing from ibiblio
|
|
|
@ -1,46 +0,0 @@
|
||||||
-----
|
|
||||||
Maven Java objects (Mojos)
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
----
|
|
||||||
|
|
||||||
Maven Java objects
|
|
||||||
|
|
||||||
Maven Java objects try to be the simplest form of Java object that can be
|
|
||||||
|
|
||||||
|
|
||||||
+-----+
|
|
||||||
public class CompilerMojo
|
|
||||||
extends AbstractMojo
|
|
||||||
{
|
|
||||||
public void execute( MojoRequest request, MojoResponse response )
|
|
||||||
{
|
|
||||||
// Extract parameters from the request
|
|
||||||
|
|
||||||
String sourceDirectory = (String) request.getParameter( "sourceDirectory" );
|
|
||||||
|
|
||||||
String outputDirectory = (String) request.getParameter( "outputDirectory" );
|
|
||||||
|
|
||||||
try
|
|
||||||
{
|
|
||||||
compiler.compile( sourceDirectory, outputDirectory );
|
|
||||||
}
|
|
||||||
catch( Exception e )
|
|
||||||
{
|
|
||||||
response.setException( e );
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+-----+
|
|
||||||
|
|
||||||
Parameters available to Mojos
|
|
||||||
|
|
||||||
*----------*-------------------------------------------------------------------*
|
|
||||||
#project | The MavenProject object:
|
|
||||||
| You can use #project itself or any valid OGNL expression to
|
|
||||||
| extract any part of the MavenProject object graph
|
|
||||||
*----------*-------------------------------------------------------------------*
|
|
||||||
#component | Any arbitrary Plexus component:
|
|
||||||
| By using the role name of the plexus component you can use the
|
|
||||||
| said component in your mojo. Usage: #component.<role>
|
|
||||||
*----------*-------------------------------------------------------------------*
|
|
|
@ -1,15 +0,0 @@
|
||||||
-----
|
|
||||||
Maven plugins
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Maven plugins
|
|
||||||
|
|
||||||
Maven plugins are comprised of any number of {{{mojos.html}mojos}} which are simple classes that
|
|
||||||
perform a single action and goals that are a parameterized execution of a mojo.
|
|
||||||
|
|
||||||
Goals can also be a different parameterization of the same mojo.
|
|
||||||
|
|
||||||
This definition could certainly be refined and cleaned up with some examples
|
|
||||||
and diagrams.
|
|
|
@ -1,42 +0,0 @@
|
||||||
-----
|
|
||||||
Ibiblio syncing
|
|
||||||
-----
|
|
||||||
The Maven Team
|
|
||||||
-----
|
|
||||||
|
|
||||||
Ibiblio syncing
|
|
||||||
|
|
||||||
The requirements for setting up an automated sync with Ibiblio are as
|
|
||||||
follows:
|
|
||||||
|
|
||||||
* An account with the user name <<<rsync>>>.
|
|
||||||
|
|
||||||
* Install this ssh2 DSA public key. You do this by concatenating the
|
|
||||||
public key to your <<<authorized_keys>>> file in the <<<.ssh>>> directory
|
|
||||||
of the user you set up for syncing.
|
|
||||||
|
|
||||||
* Provide the host name and directory on the host where your maven repository
|
|
||||||
is located.
|
|
||||||
|
|
||||||
Ulimately we want to be able to create a simple rsync script that can be
|
|
||||||
run from the Ibiblio server. It might look like the following:
|
|
||||||
|
|
||||||
+-----+
|
|
||||||
rsync -rvl --size-only --ignore-existing --rsh="ssh -l rsync" beaver.codehaus.org:/dist/ /public/html/maven
|
|
||||||
+-----+
|
|
||||||
|
|
||||||
The diretory that we sync from your end must be in the format of a maven
|
|
||||||
repository. A simple example of the layout expected is as follows:
|
|
||||||
|
|
||||||
+----+
|
|
||||||
.
|
|
||||||
|-- osworkflow
|
|
||||||
| |-- jars
|
|
||||||
| |-- licenses
|
|
||||||
| `-- poms
|
|
||||||
`-- sitemesh
|
|
||||||
|-- jars
|
|
||||||
|-- licenses
|
|
||||||
`-- poms
|
|
||||||
|
|
||||||
+----+
|
|
|
@ -10,14 +10,14 @@
|
||||||
</p>
|
</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>
|
<li>
|
||||||
<i>Project</i> - most static configuration occurs in
|
<i>Project</i>- most static configuration occurs in
|
||||||
<code>pom.xml</code>
|
<code>pom.xml</code>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<i>Installation</i> - this is configuration added once for a Maven installation (not supported in the initial Technology Preview)
|
<i>Installation</i>- this is configuration added once for a Maven installation
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<i>User</i> - this is configuration specific to a particular user
|
<i>User</i>- this is configuration specific to a particular user
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>
|
<p>
|
||||||
|
@ -25,17 +25,18 @@
|
||||||
building it, while the others both define settings for the current environment.
|
building it, while the others both define settings for the current environment.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<b>Note: </b> the installation and user configuration can not be used to add shared project information -
|
<b>Note:</b>the installation and user configuration can not be used to add shared project information -
|
||||||
for example setting
|
for example setting
|
||||||
<code><organization></code> or
|
<code><organization></code>or
|
||||||
<code><distributionManagement></code> company-wide.
|
<code><distributionManagement></code>company-wide.
|
||||||
For this, you should have your projects inherit from a company-wide parent
|
For this, you should have your projects inherit from a company-wide parent
|
||||||
<code>pom.xml</code>.
|
<code>pom.xml</code>.
|
||||||
<!-- TODO: versioning doc that discusses this -->
|
<!-- TODO: versioning doc that discusses this -->
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
You can specify your user configuration in <code>${user.home}/.m2/settings.xml</code>. A
|
You can specify your user configuration in
|
||||||
<a href="maven-settings/settings.html">full reference</a> to the
|
<code>${user.home}/.m2/settings.xml</code>. A
|
||||||
|
<a href="maven-settings/settings.html">full reference</a>to the
|
||||||
configuration file is available. This section will show how to make some common configurations.
|
configuration file is available. This section will show how to make some common configurations.
|
||||||
Note that the file is not required - defaults will be used if it is not found.
|
Note that the file is not required - defaults will be used if it is not found.
|
||||||
</p>
|
</p>
|
||||||
|
@ -58,13 +59,15 @@
|
||||||
<p>
|
<p>
|
||||||
You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and
|
You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and
|
||||||
password are only required if your proxy requires basic authentication (note that later alphas will support
|
password are only required if your proxy requires basic authentication (note that later alphas will support
|
||||||
storing your passwords in a secured keystore - in the mean time, please ensure your <code>settings.xml</code>
|
storing your passwords in a secured keystore - in the mean time, please ensure your
|
||||||
|
<code>settings.xml</code>
|
||||||
file is secured with permissions appropriate for your operating system).
|
file is secured with permissions appropriate for your operating system).
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
The <code>nonProxyHosts</code> setting accepts wild cards, and each host not to proxy is separated by the
|
The
|
||||||
<code>|</code> character. This matches the
|
<code>nonProxyHosts</code>setting accepts wild cards, and each host not to proxy is separated by the
|
||||||
<a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html">JDK configuration</a> equivalent.
|
<code>|</code>character. This matches the
|
||||||
|
<a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html">JDK configuration</a>equivalent.
|
||||||
</p>
|
</p>
|
||||||
<source><![CDATA[
|
<source><![CDATA[
|
||||||
<settings>
|
<settings>
|
||||||
|
@ -85,14 +88,17 @@
|
||||||
.]]></source>
|
.]]></source>
|
||||||
<h4>Security and Deployment Settings</h4>
|
<h4>Security and Deployment Settings</h4>
|
||||||
<p>
|
<p>
|
||||||
Repositories to deploy to are defined in a project in the <code><distributionManagement></code> section.
|
Repositories to deploy to are defined in a project in the
|
||||||
|
<code><distributionManagement></code>section.
|
||||||
However, you cannot put your username, password, or other security settings in that project. For that reason,
|
However, you cannot put your username, password, or other security settings in that project. For that reason,
|
||||||
you should add a server definition to your own settings with an <code>id</code> that matches that of the
|
you should add a server definition to your own settings with an
|
||||||
|
<code>id</code>that matches that of the
|
||||||
deployment repository in the project.
|
deployment repository in the project.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
In addition, some repositories may require authorisation to download from, so the corresponding settings can
|
In addition, some repositories may require authorisation to download from, so the corresponding settings can
|
||||||
be specified in a <code>server</code> element in the same way.
|
be specified in a
|
||||||
|
<code>server</code>element in the same way.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
Which settings are required will depend on the type of repository you are deploying to. As of the first release,
|
Which settings are required will depend on the type of repository you are deploying to. As of the first release,
|
||||||
|
@ -133,8 +139,12 @@
|
||||||
</ul>
|
</ul>
|
||||||
<p>
|
<p>
|
||||||
To configure a mirror of a given repository, you provide it in your settings file, giving the new repository
|
To configure a mirror of a given repository, you provide it in your settings file, giving the new repository
|
||||||
it's own <code>id</code> and <code>url</code>, and specify the <code>mirrorOf</code> setting that is the ID of
|
it's own
|
||||||
the repository you are using a mirror of. For example, the ID of the main Maven repository included by default is
|
<code>id</code>and
|
||||||
|
<code>url</code>, and specify the
|
||||||
|
<code>mirrorOf</code>setting that is the ID of
|
||||||
|
the repository you are using a mirror of. For example, the ID of the main Maven repository included by default
|
||||||
|
is
|
||||||
<code>central</code>, so to use an Australian mirror, you would configure the following:
|
<code>central</code>, so to use an Australian mirror, you would configure the following:
|
||||||
</p>
|
</p>
|
||||||
<source><![CDATA[
|
<source><![CDATA[
|
||||||
|
@ -152,7 +162,7 @@
|
||||||
.
|
.
|
||||||
.]]></source>
|
.]]></source>
|
||||||
<p>
|
<p>
|
||||||
<i>Please note:</i> this particular is not actually set up for Maven 2 yet, so this should be treated as an
|
<i>Please note:</i>this particular is not actually set up for Maven 2 yet, so this should be treated as an
|
||||||
example only.
|
example only.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -18,15 +18,21 @@
|
||||||
</li>
|
</li>
|
||||||
<li>deployment mechanism</li>
|
<li>deployment mechanism</li>
|
||||||
<li>dependency management</li>
|
<li>dependency management</li>
|
||||||
<li>plugin management - <i>in progress by J Matthew Pryor and John Casey</i></li>
|
<li>plugin management -
|
||||||
|
<i>in progress by J Matthew Pryor and John Casey</i>
|
||||||
|
</li>
|
||||||
<li>plugin configuration</li>
|
<li>plugin configuration</li>
|
||||||
<li>plugin downloading - <i>partial on Brett's blogs</i></li>
|
<li>plugin downloading -
|
||||||
<li>site generation</li>
|
<i>partial on Brett's blogs</i>
|
||||||
|
</li>
|
||||||
<li>report generation</li>
|
<li>report generation</li>
|
||||||
<li>project inheritence and company wide strategy</li>
|
<li>project inheritence and company wide strategy</li>
|
||||||
|
<li>plugin documentation</li>
|
||||||
|
<li>archetypes - writing and using</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h4>Documentation for plugin authors</h4>
|
<h4>Documentation for plugin authors</h4>
|
||||||
<ul>
|
<ul>
|
||||||
|
<li>Beanshell examples</li>
|
||||||
<li>plugin writing guide</li>
|
<li>plugin writing guide</li>
|
||||||
<li>report writing guide</li>
|
<li>report writing guide</li>
|
||||||
<li>site customisation guide</li>
|
<li>site customisation guide</li>
|
||||||
|
|
Loading…
Reference in New Issue