regenerate project and settings descriptor

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@169605 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter 2005-05-11 08:25:53 +00:00
parent b4bbf3071d
commit e15ca2b246
2 changed files with 1066 additions and 1011 deletions

View File

@ -1,14 +1,14 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Maven's model for Java project.</title>
<title>Maven</title>
</properties>
<body>
<section name="Maven's model for Java project.">
<p>
<section name="Maven">
<p>Maven's model for Java project.</p>
<source>
&lt;<a href="#Model">project</a>&gt;
&lt;<a href="#Parent">parent</a>&gt;
&lt;<a href="#class_Model">project</a>&gt;
&lt;<a href="#class_Parent">parent</a>&gt;
&lt;artifactId/&gt;
&lt;groupId/&gt;
&lt;version/&gt;
@ -22,15 +22,15 @@
&lt;version/&gt;
&lt;description/&gt;
&lt;url/&gt;
&lt;<a href="#IssueManagement">issueManagement</a>&gt;
&lt;<a href="#class_IssueManagement">issueManagement</a>&gt;
&lt;system/&gt;
&lt;url/&gt;
&lt;/issueManagement&gt;
&lt;<a href="#CiManagement">ciManagement</a>&gt;
&lt;<a href="#class_CiManagement">ciManagement</a>&gt;
&lt;system/&gt;
&lt;url/&gt;
&lt;notifiers&gt;
&lt;<a href="#Notifier">notifier</a>&gt;
&lt;<a href="#class_Notifier">notifier</a>&gt;
&lt;type/&gt;
&lt;address/&gt;
&lt;configuration/&gt;
@ -39,7 +39,7 @@
&lt;/ciManagement&gt;
&lt;inceptionYear/&gt;
&lt;repositories&gt;
&lt;<a href="#Repository">repository</a>&gt;
&lt;<a href="#class_Repository">repository</a>&gt;
&lt;id/&gt;
&lt;name/&gt;
&lt;url/&gt;
@ -48,7 +48,7 @@
&lt;/repository&gt;
&lt;/repositories&gt;
&lt;pluginRepositories&gt;
&lt;<a href="#Repository">repository</a>&gt;
&lt;<a href="#class_Repository">repository</a>&gt;
&lt;id/&gt;
&lt;name/&gt;
&lt;url/&gt;
@ -57,7 +57,7 @@
&lt;/repository&gt;
&lt;/pluginRepositories&gt;
&lt;mailingLists&gt;
&lt;<a href="#MailingList">mailingList</a>&gt;
&lt;<a href="#class_MailingList">mailingList</a>&gt;
&lt;name/&gt;
&lt;subscribe/&gt;
&lt;unsubscribe/&gt;
@ -67,12 +67,12 @@
&lt;/mailingList&gt;
&lt;/mailingLists&gt;
&lt;developers&gt;
&lt;<a href="#Developer">developer</a>&gt;
&lt;<a href="#class_Developer">developer</a>&gt;
&lt;id/&gt;
&lt;/developer&gt;
&lt;/developers&gt;
&lt;contributors&gt;
&lt;<a href="#Contributor">contributor</a>&gt;
&lt;<a href="#class_Contributor">contributor</a>&gt;
&lt;name/&gt;
&lt;email/&gt;
&lt;url/&gt;
@ -82,7 +82,7 @@
&lt;/contributor&gt;
&lt;/contributors&gt;
&lt;dependencies&gt;
&lt;<a href="#Dependency">dependency</a>&gt;
&lt;<a href="#class_Dependency">dependency</a>&gt;
&lt;groupId/&gt;
&lt;artifactId/&gt;
&lt;version/&gt;
@ -91,23 +91,23 @@
&lt;/dependency&gt;
&lt;/dependencies&gt;
&lt;licenses&gt;
&lt;<a href="#License">license</a>&gt;
&lt;<a href="#class_License">license</a>&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;distribution/&gt;
&lt;comments/&gt;
&lt;/license&gt;
&lt;/licenses&gt;
&lt;<a href="#Reports">reports</a>&gt;
&lt;<a href="#class_Reports">reports</a>&gt;
&lt;outputDirectory/&gt;
&lt;plugins&gt;
&lt;<a href="#Plugin">plugin</a>&gt;
&lt;<a href="#class_Plugin">plugin</a>&gt;
&lt;groupId/&gt;
&lt;artifactId/&gt;
&lt;version/&gt;
&lt;configuration/&gt;
&lt;goals&gt;
&lt;<a href="#Goal">goal</a>&gt;
&lt;<a href="#class_Goal">goal</a>&gt;
&lt;id/&gt;
&lt;configuration/&gt;
&lt;/goal&gt;
@ -115,22 +115,22 @@
&lt;/plugin&gt;
&lt;/plugins&gt;
&lt;/reports&gt;
&lt;<a href="#Scm">scm</a>&gt;
&lt;<a href="#class_Scm">scm</a>&gt;
&lt;connection/&gt;
&lt;developerConnection/&gt;
&lt;url/&gt;
&lt;/scm&gt;
&lt;<a href="#Build">build</a>&gt;
&lt;<a href="#class_Build">build</a>&gt;
&lt;sourceDirectory/&gt;
&lt;scriptSourceDirectory/&gt;
&lt;testSourceDirectory/&gt;
&lt;resources&gt;
&lt;<a href="#Resource">resource</a>&gt;
&lt;<a href="#class_Resource">resource</a>&gt;
&lt;targetPath/&gt;
&lt;/resource&gt;
&lt;/resources&gt;
&lt;testResources&gt;
&lt;<a href="#Resource">resource</a>&gt;
&lt;<a href="#class_Resource">resource</a>&gt;
&lt;targetPath/&gt;
&lt;/resource&gt;
&lt;/testResources&gt;
@ -138,30 +138,30 @@
&lt;outputDirectory/&gt;
&lt;finalName/&gt;
&lt;testOutputDirectory/&gt;
&lt;<a href="#PluginManagement">pluginManagement</a>/&gt;
&lt;<a href="#class_PluginManagement">pluginManagement</a>/&gt;
&lt;/build&gt;
&lt;<a href="#Organization">organization</a>&gt;
&lt;<a href="#class_Organization">organization</a>&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;/organization&gt;
&lt;<a href="#DistributionManagement">distributionManagement</a>&gt;
&lt;<a href="#Repository">repository</a>&gt;
&lt;<a href="#class_DistributionManagement">distributionManagement</a>&gt;
&lt;<a href="#class_Repository">repository</a>&gt;
&lt;id/&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;snapshotPolicy/&gt;
&lt;layout/&gt;
&lt;/repository&gt;
&lt;<a href="#Site">site</a>&gt;
&lt;<a href="#class_Site">site</a>&gt;
&lt;id/&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;/site&gt;
&lt;downloadUrl/&gt;
&lt;/distributionManagement&gt;
&lt;<a href="#DependencyManagement">dependencyManagement</a>&gt;
&lt;<a href="#class_DependencyManagement">dependencyManagement</a>&gt;
&lt;dependencies&gt;
&lt;<a href="#Dependency">dependency</a>&gt;
&lt;<a href="#class_Dependency">dependency</a>&gt;
&lt;groupId/&gt;
&lt;artifactId/&gt;
&lt;version/&gt;
@ -172,7 +172,7 @@
&lt;/dependencyManagement&gt;
&lt;/project&gt;
</source>
<a name="Model"/>
<a name="class_Model"/>
<subsection name="project">
<p>
The <code>&lt;project&gt;</code> element specifies various attributes
@ -462,7 +462,7 @@
</tr>
</table>
</subsection>
<a name="Parent"/>
<a name="class_Parent"/>
<subsection name="parent">
<table>
<tr>
@ -489,7 +489,7 @@
</tr>
</table>
</subsection>
<a name="IssueManagement"/>
<a name="class_IssueManagement"/>
<subsection name="issueManagement">
<p>
Information about the bugtracking system used to manage this project.
@ -513,7 +513,7 @@
</tr>
</table>
</subsection>
<a name="CiManagement"/>
<a name="class_CiManagement"/>
<subsection name="ciManagement">
<table>
<tr>
@ -543,7 +543,7 @@
</tr>
</table>
</subsection>
<a name="Notifier"/>
<a name="class_Notifier"/>
<subsection name="notifier">
<p>
Configures one method for notifying users/developers when a build breaks.
@ -575,7 +575,7 @@
</tr>
</table>
</subsection>
<a name="Repository"/>
<a name="class_Repository"/>
<subsection name="repository">
<p>
Repository contains the information needed
@ -627,7 +627,7 @@
</tr>
</table>
</subsection>
<a name="MailingList"/>
<a name="class_MailingList"/>
<subsection name="mailingList">
<p>
This element describes all of the mailing lists associated with
@ -698,7 +698,7 @@
</tr>
</table>
</subsection>
<a name="Developer"/>
<a name="class_Developer"/>
<subsection name="developer">
<p>
Information about one of the committers on this project. Derived from
@ -717,7 +717,7 @@
</tr>
</table>
</subsection>
<a name="Contributor"/>
<a name="class_Contributor"/>
<subsection name="contributor">
<p>
Description of a person who has contributed to the project, but who does
@ -773,7 +773,7 @@
</tr>
</table>
</subsection>
<a name="Dependency"/>
<a name="class_Dependency"/>
<subsection name="dependency">
<table>
<tr>
@ -833,7 +833,7 @@
</tr>
</table>
</subsection>
<a name="License"/>
<a name="class_License"/>
<subsection name="license">
<p>
Describes the licenses for this project. This is used to generate
@ -882,7 +882,7 @@
</tr>
</table>
</subsection>
<a name="Reports"/>
<a name="class_Reports"/>
<subsection name="reports">
<p>Section for management of reports and configuration</p>
<table>
@ -904,7 +904,7 @@
</tr>
</table>
</subsection>
<a name="Plugin"/>
<a name="class_Plugin"/>
<subsection name="plugin">
<table>
<tr>
@ -943,7 +943,7 @@
</tr>
</table>
</subsection>
<a name="Goal"/>
<a name="class_Goal"/>
<subsection name="goal">
<table>
<tr>
@ -964,7 +964,7 @@
</tr>
</table>
</subsection>
<a name="Scm"/>
<a name="class_Scm"/>
<subsection name="scm">
<table>
<tr>
@ -1001,7 +1001,7 @@
</tr>
</table>
</subsection>
<a name="Build"/>
<a name="class_Build"/>
<subsection name="build">
<table>
<tr>
@ -1115,7 +1115,7 @@
</tr>
</table>
</subsection>
<a name="Resource"/>
<a name="class_Resource"/>
<subsection name="resource">
<p>
This element describes all of the resources associated with a project or
@ -1142,7 +1142,7 @@
</tr>
</table>
</subsection>
<a name="PluginManagement"/>
<a name="class_PluginManagement"/>
<subsection name="pluginManagement">
<p>
Section for management of default plugin information for use in a group of POMs.
@ -1154,7 +1154,7 @@
</tr>
</table>
</subsection>
<a name="Organization"/>
<a name="class_Organization"/>
<subsection name="organization">
<p>Specifies the organization who produces this project.</p>
<table>
@ -1176,7 +1176,7 @@
</tr>
</table>
</subsection>
<a name="DistributionManagement"/>
<a name="class_DistributionManagement"/>
<subsection name="distributionManagement">
<p>
This elements describes all that pertains to distribution for a project.
@ -1216,7 +1216,7 @@
</tr>
</table>
</subsection>
<a name="Site"/>
<a name="class_Site"/>
<subsection name="site">
<p>
Site contains the information needed
@ -1253,7 +1253,7 @@
</tr>
</table>
</subsection>
<a name="DependencyManagement"/>
<a name="class_DependencyManagement"/>
<subsection name="dependencyManagement">
<p>
Section for management of default dependency information for use in a group of POMs.
@ -1276,7 +1276,6 @@
</tr>
</table>
</subsection>
</p>
</section>
</body>
</document>

View File

@ -1,69 +1,65 @@
<?xml version="1.0"?>
<document>
<properties>
<author email="dev@modello.codehaus.org">Maven Development Team</author>
<title>Maven Model Documentation</title>
<title>Settings</title>
</properties>
<body>
<section name="Descriptor with links">
<p>
<source>
<a href="#Settings">&lt;settings&gt;</a>
<a href="#jdks">&lt;jdks&gt;</a>
<a href="#Jdk">&lt;jdk&gt;</a>
<a href="#Jdk">&lt;active/&gt;</a>
<a href="#Jdk">&lt;version/&gt;</a>
<a href="#Jdk">&lt;javaHome/&gt;</a>
<a href="#Jdk">&lt;jdk&gt;</a>
<a href="#jdks">&lt;/jdks&gt;</a>
<a href="#proxies">&lt;proxies&gt;</a>
<a href="#Proxy">&lt;proxy&gt;</a>
<a href="#Proxy">&lt;active/&gt;</a>
<a href="#Proxy">&lt;protocol/&gt;</a>
<a href="#Proxy">&lt;username/&gt;</a>
<a href="#Proxy">&lt;password/&gt;</a>
<a href="#Proxy">&lt;port/&gt;</a>
<a href="#Proxy">&lt;host/&gt;</a>
<a href="#Proxy">&lt;nonProxyHosts/&gt;</a>
<a href="#Proxy">&lt;proxy&gt;</a>
<a href="#proxies">&lt;/proxies&gt;</a>
<a href="#servers">&lt;servers&gt;</a>
<a href="#Server">&lt;server&gt;</a>
<a href="#Server">&lt;id/&gt;</a>
<a href="#Server">&lt;username/&gt;</a>
<a href="#Server">&lt;password/&gt;</a>
<a href="#Server">&lt;privateKey/&gt;</a>
<a href="#Server">&lt;passphrase/&gt;</a>
<a href="#Server">&lt;server&gt;</a>
<a href="#servers">&lt;/servers&gt;</a>
<a href="#profiles">&lt;profiles&gt;</a>
<a href="#Profile">&lt;profile&gt;</a>
<a href="#Profile">&lt;active/&gt;</a>
<a href="#Profile">&lt;localRepository/&gt;</a>
<a href="#Profile">&lt;passwordStore/&gt;</a>
<a href="#Profile">&lt;profile&gt;</a>
<a href="#profiles">&lt;/profiles&gt;</a>
<a href="#Settings">&lt;settings&gt;</a></source>
</p>
<section name="Settings">
<p>
User-specific configuration for maven. Includes things that should not
be distributed with the pom.xml file, such as developer identity, along with
local settings, like proxy information.</p>
<source>
&lt;<a href="#class_Settings">settings</a>&gt;
&lt;proxies&gt;
&lt;<a href="#class_Proxy">proxy</a>&gt;
&lt;active/&gt;
&lt;protocol/&gt;
&lt;username/&gt;
&lt;password/&gt;
&lt;port/&gt;
&lt;host/&gt;
&lt;nonProxyHosts/&gt;
&lt;/proxy&gt;
&lt;/proxies&gt;
&lt;servers&gt;
&lt;<a href="#class_Server">server</a>&gt;
&lt;id/&gt;
&lt;username/&gt;
&lt;password/&gt;
&lt;privateKey/&gt;
&lt;passphrase/&gt;
&lt;/server&gt;
&lt;/servers&gt;
&lt;mirrors&gt;
&lt;<a href="#class_Mirror">mirror</a>&gt;
&lt;id/&gt;
&lt;mirrorOf/&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;/mirror&gt;
&lt;/mirrors&gt;
&lt;profiles&gt;
&lt;<a href="#class_Profile">profile</a>&gt;
&lt;active/&gt;
&lt;localRepository/&gt;
&lt;offline/&gt;
&lt;/profile&gt;
&lt;/profiles&gt;
&lt;/settings&gt;
</source>
<a name="class_Settings"/>
<subsection name="settings">
<p>Root element of the user configuration file.</p>
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>jdks</td>
<td>
Configuration for different java environment profiles. One good use
for this might be to configure both JDK 1.4 and JDK 1.5 to work with
maven. Profiles will allow switching of entire java environments
based on the profile id, either in the defaults section below, or on
the command line.
<code>proxies</code>
</td>
</tr>
<tr>
<td>proxies</td>
<td>
Configuration for different proxy profiles. Multiple proxy profiles
might come in handy for anyone working from a notebook or other
@ -73,7 +69,9 @@
</td>
</tr>
<tr>
<td>servers</td>
<td>
<code>servers</code>
</td>
<td>
Configuration of server-specific settings, mainly authentication
method. This allows configuration of authentication on a per-server
@ -81,7 +79,17 @@
</td>
</tr>
<tr>
<td>profiles</td>
<td>
<code>mirrors</code>
</td>
<td>
Configuration of download mirrors for repositories.
</td>
</tr>
<tr>
<td>
<code>profiles</code>
</td>
<td>
Configuration for different runtime profiles for maven itself. For
example, this will allow plugin developers to switch from a "work"
@ -92,130 +100,178 @@
</td>
</tr>
</table>
</p>
</section>
<section name="Jdk">
<p>
</subsection>
<a name="class_Proxy"/>
<subsection name="proxy">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>active</td>
<td>Whether this JDK is the active one.</td>
</tr>
<tr>
<td>version</td>
<td>The JDK major version (eg. '1.4').</td>
</tr>
<tr>
<td>javaHome</td>
<td>The JDK home.</td>
</tr>
</table>
</p>
</section>
<section name="Proxy">
<p>
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>active</td>
<td>
<code>active</code>
</td>
<td>Whether this proxy configuration is the active one.</td>
</tr>
<tr>
<td>protocol</td>
<td>
<code>protocol</code>
</td>
<td>The proxy protocol.</td>
</tr>
<tr>
<td>username</td>
<td>
<code>username</code>
</td>
<td>The proxy user.</td>
</tr>
<tr>
<td>password</td>
<td>
<code>password</code>
</td>
<td>The proxy password.</td>
</tr>
<tr>
<td>port</td>
<td>
<code>port</code>
</td>
<td>The proxy port.</td>
</tr>
<tr>
<td>host</td>
<td>
<code>host</code>
</td>
<td>The proxy host.</td>
</tr>
<tr>
<td>nonProxyHosts</td>
<td>
<code>nonProxyHosts</code>
</td>
<td>
The list of non-proxied hosts (usually
comma-delimited).
</td>
</tr>
</table>
</p>
</section>
<section name="Server">
<p>
</subsection>
<a name="class_Server"/>
<subsection name="server">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>id</td>
<td>
<code>id</code>
</td>
<td>
The ID of this configuration for indicating the default or "active"
profile.
</td>
</tr>
<tr>
<td>username</td>
<td>
<code>username</code>
</td>
<td>The username used to authenticate.</td>
</tr>
<tr>
<td>password</td>
<td>
<code>password</code>
</td>
<td>
The password used in conjunction with the username to authenticate.
</td>
</tr>
<tr>
<td>privateKey</td>
<td>
<code>privateKey</code>
</td>
<td>The private key location used to authenticate.</td>
</tr>
<tr>
<td>passphrase</td>
<td>
<code>passphrase</code>
</td>
<td>
The passphrase used in conjunction with the privateKey to authenticate.
</td>
</tr>
</table>
</p>
</section>
<section name="Profile">
</subsection>
<a name="class_Mirror"/>
<subsection name="mirror">
<p>
A download mirror for a given repository.
</p>
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>active</td>
<td>
<code>id</code>
</td>
<td>
The server ID of this mirror. This must -not- be the same as that of the repository you are mirroring.
</td>
</tr>
<tr>
<td>
<code>mirrorOf</code>
</td>
<td>
The server ID of the repository being mirrored, eg "central".
</td>
</tr>
<tr>
<td>
<code>name</code>
</td>
<td>
The optional name that describes the mirror.
</td>
</tr>
<tr>
<td>
<code>url</code>
</td>
<td>
The URL of the mirror repository.
</td>
</tr>
</table>
</subsection>
<a name="class_Profile"/>
<subsection name="profile">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>active</code>
</td>
<td>Whether this is the active maven profile.</td>
</tr>
<tr>
<td>localRepository</td>
<td>
<code>localRepository</code>
</td>
<td>The local repository.</td>
</tr>
<tr>
<td>passwordStore</td>
<td>The keystore used to store passwords.</td>
<td>
<code>offline</code>
</td>
<td>Indicate whether maven should operate in offline mode full-time.</td>
</tr>
</table>
</p>
</section>
</subsection>
</section>
</body>
</document>