You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2020/03/10 19:55:26 UTC
svn commit: r1875052 [4/4] - in /maven/website/content: ./
apache-resource-bundles/ developers/ developers/release/ docs/3.2.1/
docs/3.2.2/ docs/3.3.1/ docs/3.3.9/ docs/3.5.0-alpha-1/ docs/3.5.0-beta-1/
docs/3.5.0/ docs/3.5.3/ docs/3.5.4/ docs/3.6.0/ d...
Modified: maven/website/content/repository/index.html
==============================================================================
--- maven/website/content/repository/index.html (original)
+++ maven/website/content/repository/index.html Tue Mar 10 19:55:25 2020
@@ -136,9 +136,9 @@
<h2><a name="Maven_Central_Repository"></a>Maven Central Repository</h2>
-<p>This documentation is for those that need to use or contribute to the Maven central repository. This includes those
+<p>This documentation is for those that need to use or contribute to the Maven <code>central</code> repository. This includes those
that need dependencies for their own build or projects that wish to have
- their releases added to the Maven central repository, even if they don't use Maven as their build tool.</p>
+ their releases added to the Maven <code>central</code> repository, even if they don't use Maven as their build tool.</p>
<p><img src="../images/icon_warning_sml.gif" alt="" />
Modified: maven/website/content/settings.html
==============================================================================
--- maven/website/content/settings.html (original)
+++ maven/website/content/settings.html Tue Mar 10 19:55:25 2020
@@ -199,16 +199,16 @@ under the License.
</ol></section><section>
<h2><a name="Introduction"></a>Introduction</h2><section>
<h3><a name="Quick_Overview"></a>Quick Overview</h3>
-<p>The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.</p>
-<p>There are two locations where a settings.xml file may live:</p>
+<p>The <code>settings</code> element in the <code>settings.xml</code> file contains elements used to define values which configure Maven execution in various ways, like the <code>pom.xml</code>, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.</p>
+<p>There are two locations where a <code>settings.xml</code> file may live:</p>
<ul>
-<li>The Maven install: ${maven.home}/conf/settings.xml</li>
-<li>A user’s install: ${user.home}/.m2/settings.xml</li>
+<li>The Maven install: <code>${maven.home}/conf/settings.xml</code></li>
+<li>A user’s install: <code>${user.home}/.m2/settings.xml</code></li>
</ul>
-<p>The former settings.xml are also called global settings, the latter settings.xml are referred to as user settings. If both files exists, their contents gets merged, with the user-specific settings.xml being dominant.</p>
-<p>Tip: If you need to create user-specific settings from scratch, it’s easiest to copy the global settings from your Maven installation to your ${user.home}/.m2 directory. Maven’s default settings.xml is a template with comments and examples so you can quickly tweak it to match your needs.</p>
-<p>Here is an overview of the top elements under settings:</p>
+<p>The former <code>settings.xml</code> are also called global settings, the latter <code>settings.xml</code> are referred to as user settings. If both files exists, their contents gets merged, with the user-specific <code>settings.xml</code> being dominant.</p>
+<p>Tip: If you need to create user-specific settings from scratch, it’s easiest to copy the global settings from your Maven installation to your <code>${user.home}/.m2</code> directory. Maven’s default <code>settings.xml</code> is a template with comments and examples so you can quickly tweak it to match your needs.</p>
+<p>Here is an overview of the top elements under <code>settings</code>:</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums"> <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -227,16 +227,16 @@ under the License.
</settings>
</pre></div></div>
-<p>The contents of the settings.xml can be interpolated using the following expressions:</p>
+<p>The contents of the <code>settings.xml</code> can be interpolated using the following expressions:</p>
<ol style="list-style-type: decimal">
-<li>${user.home} and all other system properties <i>(since Maven 3.0)</i></li>
-<li>${env.HOME} etc. for environment variables</li>
+<li><code>${user.home}</code> and all other system properties <i>(since Maven 3.0)</i></li>
+<li><code>${env.HOME}</code> etc. for environment variables</li>
</ol>
-<p>Note that properties defined in profiles within the settings.xml cannot be used for interpolation.</p></section></section><section>
+<p>Note that properties defined in profiles within the <code>settings.xml</code> cannot be used for interpolation.</p></section></section><section>
<h2><a name="Settings_Details"></a>Settings Details</h2><section>
<h3><a name="Simple_Values"></a>Simple Values</h3>
-<p>Half of the top-level settings elements are simple values, representing a range of values which describe elements of the build system that are active full-time.</p>
+<p>Half of the top-level <code>settings</code> elements are simple values, representing a range of values which describe elements of the build system that are active full-time.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums"><settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -252,12 +252,12 @@ under the License.
<ul>
-<li><b>localRepository</b>: This value is the path of this build system’s local repository. The default value is ${user.home}/.m2/repository. This element is especially useful for a main build server allowing all logged-in users to build from a common local repository.</li>
-<li><b>interactiveMode</b>: true if Maven should attempt to interact with the user for input, false if not. Defaults to true.</li>
-<li><b>offline</b>: true if this build system should operate in offline mode, defaults to false. This element is useful for build servers which cannot connect to a remote repository, either because of network setup or security reasons.</li>
+<li><b>localRepository</b>: This value is the path of this build system’s local repository. The default value is <code>${user.home}/.m2/repository</code>. This element is especially useful for a main build server allowing all logged-in users to build from a common local repository.</li>
+<li><b>interactiveMode</b>: <code>true</code> if Maven should attempt to interact with the user for input, <code>false</code> if not. Defaults to <code>true</code>.</li>
+<li><b>offline</b>: <code>true</code> if this build system should operate in offline mode, defaults to <code>false</code>. This element is useful for build servers which cannot connect to a remote repository, either because of network setup or security reasons.</li>
</ul></section><section>
<h3><a name="Plugin_Groups"></a>Plugin Groups</h3>
-<p>This element contains a list of pluginGroup elements, each contains a groupId. The list is searched when a plugin is used and the groupId is not provided in the command line. This list automatically contains org.apache.maven.plugins and org.codehaus.mojo.</p>
+<p>This element contains a list of <code>pluginGroup</code> elements, each contains a groupId. The list is searched when a plugin is used and the groupId is not provided in the command line. This list automatically contains <code>org.apache.maven.plugins</code> and <code>org.codehaus.mojo</code>.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums"><settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -272,14 +272,14 @@ under the License.
</settings>
</pre></div></div>
-<p>For example, given the above settings the Maven command line may execute org.eclipse.jetty:jetty-maven-plugin:run with the truncated command:</p>
+<p>For example, given the above settings the Maven command line may execute <code>org.eclipse.jetty:jetty-maven-plugin:run</code> with the truncated command:</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">mvn jetty:run
</pre></div></div>
</section><section>
<h3><a name="Servers"></a>Servers</h3>
-<p>The repositories for download and deployment are defined by the <a href="./pom.html#Repositories">repositories</a> and <a href="./pom.html#Distribution_Management">distributionManagement</a> elements of the POM. However, certain settings such as username and password should not be distributed along with the pom.xml. This type of information should exist on the build server in the settings.xml.</p>
+<p>The repositories for download and deployment are defined by the <a href="./pom.html#Repositories"><code>repositories</code></a> and <a href="./pom.html#Distribution_Management"><code>distributionManagement</code></a> elements of the POM. However, certain settings such as <code>username</code> and <code>password</code> should not be distributed along with the <code>pom.xml</code>. This type of information should exist on the build server in the <code>settings.xml</code>.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums"><settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -305,12 +305,12 @@ under the License.
<ul>
-<li><b>id</b>: This is the ID of the server <i>(not of the user to login as)</i> that matches the id element of the repository/mirror that Maven tries to connect to.</li>
+<li><b>id</b>: This is the ID of the server <i>(not of the user to login as)</i> that matches the <code>id</code> element of the repository/mirror that Maven tries to connect to.</li>
<li><b>username</b>, <b>password</b>: These elements appear as a pair denoting the login and password required to authenticate to this server.</li>
-<li><b>privateKey</b>, <b>passphrase</b>: Like the previous two elements, this pair specifies a path to a private key (default is ${user.home}/.ssh/id_dsa) and a passphrase, if required. The passphrase and password elements may be externalized in the future, but for now they must be set plain-text in the settings.xml file.</li>
+<li><b>privateKey</b>, <b>passphrase</b>: Like the previous two elements, this pair specifies a path to a private key (default is <code>${user.home}/.ssh/id_dsa</code>) and a <code>passphrase</code>, if required. The <code>passphrase</code> and <code>password</code> elements may be externalized in the future, but for now they must be set plain-text in the <code>settings.xml</code> file.</li>
<li><b>filePermissions</b>, <b>directoryPermissions</b>: When a repository file or directory is created on deployment, these are the permissions to use. The legal values of each is a three digit number corresponding to *nix file permissions, e.g. 664, or 775.</li>
</ul>
-<p><i>Note:</i> If you use a private key to login to the server, make sure you omit the <password> element. Otherwise, the key will be ignored.</p><section>
+<p><i>Note:</i> If you use a private key to login to the server, make sure you omit the <code><password></code> element. Otherwise, the key will be ignored.</p><section>
<h4><a name="Password_Encryption"></a>Password Encryption</h4>
<p>A new feature - server password and passphrase encryption has been added to 2.1.0+. See details <a href="./guides/mini/guide-encryption.html">on this page</a></p></section></section><section>
<h3><a name="Mirrors"></a>Mirrors</h3>
@@ -335,9 +335,9 @@ under the License.
<ul>
-<li><b>id</b>, <b>name</b>: The unique identifier and user-friendly name of this mirror. The id is used to differentiate between mirror elements and to pick the corresponding credentials from the <a href="#Servers"><servers></a> section when connecting to the mirror.</li>
+<li><b>id</b>, <b>name</b>: The unique identifier and user-friendly name of this mirror. The <code>id</code> is used to differentiate between <code>mirror</code> elements and to pick the corresponding credentials from the <a href="#Servers"><code><servers></code></a> section when connecting to the mirror.</li>
<li><b>url</b>: The base URL of this mirror. The build system will use this URL to connect to a repository rather than the original repository URL.</li>
-<li><b>mirrorOf</b>: The id of the repository that this is a mirror of. For example, to point to a mirror of the Maven central repository (https://repo.maven.apache.org/maven2/), set this element to central. More advanced mappings like repo1,repo2 or *,!inhouse are also possible. This must not match the mirror id.</li>
+<li><b>mirrorOf</b>: The <code>id</code> of the repository that this is a mirror of. For example, to point to a mirror of the Maven <code>central</code> repository (<code>https://repo.maven.apache.org/maven2/</code>), set this element to <code>central</code>. More advanced mappings like <code>repo1,repo2</code> or <code>*,!inhouse</code> are also possible. This must not match the mirror <code>id</code>.</li>
</ul>
<p>For a more in-depth introduction of mirrors, please read the <a href="./guides/mini/guide-mirror-settings.html">Guide to Mirror Settings</a>.</p></section><section>
<h3><a name="Proxies"></a>Proxies</h3>
@@ -366,17 +366,17 @@ under the License.
<ul>
-<li><b>id</b>: The unique identifier for this proxy. This is used to differentiate between proxy elements.</li>
-<li><b>active</b>: true if this proxy is active. This is useful for declaring a set of proxies, but only one may be active at a time.</li>
-<li><b>protocol</b>, <b>host</b>, <b>port</b>: The protocol://host:port of the proxy, separated into discrete elements.</li>
+<li><b>id</b>: The unique identifier for this proxy. This is used to differentiate between <code>proxy</code> elements.</li>
+<li><b>active</b>: <code>true</code> if this proxy is active. This is useful for declaring a set of proxies, but only one may be active at a time.</li>
+<li><b>protocol</b>, <b>host</b>, <b>port</b>: The <code>protocol://host:port</code> of the proxy, separated into discrete elements.</li>
<li><b>username</b>, <b>password</b>: These elements appear as a pair denoting the login and password required to authenticate to this proxy server.</li>
<li><b>nonProxyHosts</b>: This is a list of hosts which should not be proxied. The delimiter of the list is the expected type of the proxy server; the example above is pipe delimited - comma delimited is also common.</li>
</ul></section><section>
<h3><a name="Profiles"></a>Profiles</h3>
-<p>The profile element in the settings.xml is a truncated version of the pom.xml profile element. It consists of the activation, repositories, pluginRepositories and properties elements. The profile elements only include these four elements because they concerns themselves with the build system as a whole (which is the role of the settings.xml file), not about individual project object model settings.</p>
-<p>If a profile is active from settings, its values will override any equivalently ID’d profiles in a POM or profiles.xml file.</p><section>
+<p>The <code>profile</code> element in the <code>settings.xml</code> is a truncated version of the <code>pom.xml</code> <code>profile</code> element. It consists of the <code>activation</code>, <code>repositories</code>, <code>pluginRepositories</code> and <code>properties</code> elements. The <code>profile</code> elements only include these four elements because they concerns themselves with the build system as a whole (which is the role of the <code>settings.xml</code> file), not about individual project object model settings.</p>
+<p>If a profile is active from <code>settings</code>, its values will override any equivalently ID’d profiles in a POM or <code>profiles.xml</code> file.</p><section>
<h4><a name="Activation"></a>Activation</h4>
-<p>Activations are the key of a profile. Like the POM’s profiles, the power of a profile comes from its ability to modify some values only under certain circumstances; those circumstances are specified via an activation element.</p>
+<p>Activations are the key of a profile. Like the POM’s profiles, the power of a profile comes from its ability to modify some values only under certain circumstances; those circumstances are specified via an <code>activation</code> element.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums"><settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -415,27 +415,27 @@ under the License.
<p>Activation occurs when all specified criteria have been met, though not all are required at once.</p>
<ul>
-<li><b>jdk</b>: activation has a built in, Java-centric check in the jdk element. This will activate if the test is run under a jdk version number that matches the prefix given. In the above example, 1.5.0_06 will match. Ranges are also supported as of Maven 2.1. See the <a class="externalLink" href="https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html">maven-enforcer-plugin</a> for more details about supported ranges.</li>
-<li><b>os</b>: The os element can define some operating system specific properties shown above. See the <a class="externalLink" href="https://maven.apache.org/plugins/maven-enforcer-plugin/rules/requireOS.html">maven-enforcer-plugin</a> for more details about OS values.</li>
-<li><b>property</b>: The profile will activate if Maven detects a property (a value which can be dereferenced within the POM by ${name}) of the corresponding name=value pair.</li>
-<li><b>file</b>: Finally, a given filename may activate the profile by the existence of a file, or if it is missing.</li>
+<li><b>jdk</b>: <code>activation</code> has a built in, Java-centric check in the <code>jdk</code> element. This will activate if the test is run under a jdk version number that matches the prefix given. In the above example, <code>1.5.0_06</code> will match. Ranges are also supported as of Maven 2.1. See the <a class="externalLink" href="https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html">maven-enforcer-plugin</a> for more details about supported ranges.</li>
+<li><b>os</b>: The <code>os</code> element can define some operating system specific properties shown above. See the <a class="externalLink" href="https://maven.apache.org/plugins/maven-enforcer-plugin/rules/requireOS.html">maven-enforcer-plugin</a> for more details about OS values.</li>
+<li><b>property</b>: The <code>profile</code> will activate if Maven detects a property (a value which can be dereferenced within the POM by <code>${name}</code>) of the corresponding <code>name=value</code> pair.</li>
+<li><b>file</b>: Finally, a given filename may activate the <code>profile</code> by the <code>existence</code> of a file, or if it is <code>missing</code>.</li>
</ul>
-<p>The activation element is not the only way that a profile may be activated. The settings.xml file’s activeProfile element may contain the profile’s id. They may also be activated explicitly through the command line via a comma separated list after the -P flag (e.g. -P test).</p>
-<p><i>To see which profile will activate in a certain build, use the</i> maven-help-plugin.</p>
+<p>The <code>activation</code> element is not the only way that a <code>profile</code> may be activated. The <code>settings.xml</code> file’s <code>activeProfile</code> element may contain the profile’s <code>id</code>. They may also be activated explicitly through the command line via a comma separated list after the <code>-P</code> flag (e.g. <code>-P test</code>).</p>
+<p><i>To see which profile will activate in a certain build, use the</i> <code>maven-help-plugin</code>.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">mvn help:active-profiles
</pre></div></div>
</section><section>
<h4><a name="Properties"></a>Properties</h4>
-<p>Maven properties are value placeholder, like properties in Ant. Their values are accessible anywhere within a POM by using the notation ${X}, where X is the property. They come in five different styles, all accessible from the settings.xml file:</p>
+<p>Maven properties are value placeholder, like properties in Ant. Their values are accessible anywhere within a POM by using the notation <code>${X}</code>, where <code>X</code> is the property. They come in five different styles, all accessible from the <code>settings.xml</code> file:</p>
<ol style="list-style-type: decimal">
-<li>env.X: Prefixing a variable with “env.” will return the shell’s environment variable. For example, ${env.PATH} contains the $path environment variable (%PATH% in Windows).</li>
-<li>project.x: A dot (.) notated path in the POM will contain the corresponding element’s value. For example: <project><version>1.0</version></project> is accessible via ${project.version}.</li>
-<li>settings.x: A dot (.) notated path in the settings.xml will contain the corresponding element’s value. For example: <settings><offline>false</offline></settings> is accessible via ${settings.offline}.</li>
-<li>Java System Properties: All properties accessible via java.lang.System.getProperties() are available as POM properties, such as ${java.home}.</li>
-<li>x: Set within a <properties /> element or an external files, the value may be used as ${someVar}.</li>
+<li><code>env.X</code>: Prefixing a variable with “env.” will return the shell’s environment variable. For example, <code>${env.PATH}</code> contains the $path environment variable (<code>%PATH%</code> in Windows).</li>
+<li><code>project.x</code>: A dot (.) notated path in the POM will contain the corresponding element’s value. For example: <code><project><version>1.0</version></project></code> is accessible via <code>${project.version}</code>.</li>
+<li><code>settings.x</code>: A dot (.) notated path in the <code>settings.xml</code> will contain the corresponding element’s value. For example: <code><settings><offline>false</offline></settings></code> is accessible via <code>${settings.offline}</code>.</li>
+<li>Java System Properties: All properties accessible via <code>java.lang.System.getProperties()</code> are available as POM properties, such as <code>${java.home}</code>.</li>
+<li><code>x</code>: Set within a <properties /> element or an external files, the value may be used as <code>${someVar}</code>.</li>
</ol><!-- -->
<div class="source">
@@ -457,7 +457,7 @@ under the License.
</settings>
</pre></div></div>
-<p>The property ${user.install} is accessible from a POM if this profile is active.</p></section><section>
+<p>The property <code>${user.install}</code> is accessible from a POM if this profile is active.</p></section><section>
<h4><a name="Repositories"></a>Repositories</h4>
<p>Repositories are remote collections of projects from which Maven uses to populate the local repository of the build system. It is from this local repository that Maven calls it plugins and dependencies. Different remote repositories may contain different projects, and under the active profile they may be searched for a matching release or snapshot artifact.</p>
@@ -501,13 +501,13 @@ under the License.
<ul>
<li><b>releases</b>, <b>snapshots</b>: These are the policies for each type of artifact, Release or snapshot. With these two sets, a POM has the power to alter the policies for each type independent of the other within a single repository. For example, one may decide to enable only snapshot downloads, possibly for development purposes.</li>
-<li><b>enabled</b>: true or false for whether this repository is enabled for the respective type (releases or snapshots).</li>
-<li><b>updatePolicy</b>: This element specifies how often updates should attempt to occur. Maven will compare the local POM’s timestamp (stored in a repository’s maven-metadata file) to the remote. The choices are: always, daily (default), interval:X (where X is an integer in minutes) or never.</li>
-<li><b>checksumPolicy</b>: When Maven deploys files to the repository, it also deploys corresponding checksum files. Your options are to ignore, fail, or warn on missing or incorrect checksums.</li>
-<li><b>layout</b>: In the above description of repositories, it was mentioned that they all follow a common layout. This is mostly correct. Maven 2 has a default layout for its repositories; however, Maven 1.x had a different layout. Use this element to specify which if it is default or legacy.</li>
+<li><b>enabled</b>: <code>true</code> or <code>false</code> for whether this repository is enabled for the respective type (<code>releases</code> or <code>snapshots</code>).</li>
+<li><b>updatePolicy</b>: This element specifies how often updates should attempt to occur. Maven will compare the local POM’s timestamp (stored in a repository’s maven-metadata file) to the remote. The choices are: <code>always</code>, <code>daily</code> (default), <code>interval:X</code> (where X is an integer in minutes) or <code>never</code>.</li>
+<li><b>checksumPolicy</b>: When Maven deploys files to the repository, it also deploys corresponding checksum files. Your options are to <code>ignore</code>, <code>fail</code>, or <code>warn</code> on missing or incorrect checksums.</li>
+<li><b>layout</b>: In the above description of repositories, it was mentioned that they all follow a common layout. This is mostly correct. Maven 2 has a default layout for its repositories; however, Maven 1.x had a different layout. Use this element to specify which if it is <code>default</code> or <code>legacy</code>.</li>
</ul></section><section>
<h4><a name="Plugin_Repositories"></a>Plugin Repositories</h4>
-<p>Repositories are home to two major types of artifacts. The first are artifacts that are used as dependencies of other artifacts. These are the majority of artifacts that reside within central. The other type of artifact is plugins. Maven plugins are themselves a special type of artifact. Because of this, plugin repositories may be separated from other repositories (although, I have yet to hear a convincing argument for doing so). In any case, the structure of the pluginRepositories element block is similar to the repositories element. The pluginRepository elements each specify a remote location of where Maven can find new plugins.</p></section></section><section>
+<p>Repositories are home to two major types of artifacts. The first are artifacts that are used as dependencies of other artifacts. These are the majority of artifacts that reside within central. The other type of artifact is plugins. Maven plugins are themselves a special type of artifact. Because of this, plugin repositories may be separated from other repositories (although, I have yet to hear a convincing argument for doing so). In any case, the structure of the <code>pluginRepositories</code> element block is similar to the <code>repositories</code> element. The <code>pluginRepository</code> elements each specify a remote location of where Maven can find new plugins.</p></section></section><section>
<h3><a name="Active_Profiles"></a>Active Profiles</h3>
<div class="source">
@@ -522,7 +522,7 @@ under the License.
</settings>
</pre></div></div>
-<p>The final piece of the settings.xml puzzle is the activeProfiles element. This contains a set of activeProfile elements, which each have a value of a profile id. Any profile id defined as an activeProfile will be active, regardless of any environment settings. If no matching profile is found nothing will happen. For example, if env-test is an activeProfile, a profile in a pom.xml (or profile.xml with a corresponding id will be active. If no such profile is found then execution will continue as normal.</p></section></section>
+<p>The final piece of the <code>settings.xml</code> puzzle is the <code>activeProfiles</code> element. This contains a set of <code>activeProfile</code> elements, which each have a value of a <code>profile</code> <code>id</code>. Any <code>profile</code> <code>id</code> defined as an <code>activeProfile</code> will be active, regardless of any environment settings. If no matching profile is found nothing will happen. For example, if <code>env-test</code> is an <code>activeProfile</code>, a profile in a <code>pom.xml</code> (or <code>profile.xml</code> with a corresponding <code>id</code> will be active. If no such profile is found then execution will continue as normal.</p></section></section>
</main>
</div>
</div>