Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MNG-8029] improve documentation about mirror settings

This commit is contained in:
Hervé Boutemy 2024-01-29 16:54:04 +01:00 committed by Hervé Boutemy
parent 7b60c8d7dc
commit 54c1b2f28a
18 changed files with 38 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apache-maven/src/site/site.xml
View File

@ -23,9 +23,4 @@ under the License.
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
<edit>${project.scm.url}</edit>
<body>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

19
api/maven-api-settings/src/main/mdo/settings.mdo
View File

@ -28,7 +28,7 @@
<description>
<![CDATA[
<p>This is a reference for the user-specific configuration for Maven.</p>
<p>Includes things that should not be distributed with the pom.xml file, such as developer identity, along with
<p>Includes things that should not be distributed with the <code>pom.xml</code> file, such as developer identity, along with
local settings, like proxy information.</p>
<p>The default location for the settings file is {@code ~/.m2/settings.xml}.</p>
]]>
@ -90,6 +90,7 @@
<type>String</type>
<defaultValue>default</defaultValue>
<required>true</required>
<description>Item identifier.</description>
</field>
</fields>
</class>
@ -125,7 +126,7 @@
<name>usePluginRegistry</name>
<version>1.0.0+</version>
<description>
Whether Maven should use the plugin-registry.xml file to manage plugin versions.
Whether Maven should use the {@code plugin-registry.xml} file to manage plugin versions.
</description>
<type>boolean</type>
<defaultValue>false</defaultValue>
@ -405,7 +406,7 @@
<name>nonProxyHosts</name>
<version>1.0.0+</version>
<description>
The list of non-proxied hosts (delimited by |).
The list of non-proxied hosts (delimited by {@code |}).
</description>
<type>String</type>
</field>
@ -541,8 +542,12 @@
<version>1.0.0+</version>
<type>String</type>
<description>
The server ID of the repository being mirrored, e.g.,
"central". This MUST NOT match the mirror id.
<![CDATA[
A repository id or (since Maven 2.0.9) an expression matching one or many repository ids to mirror, e.g.,
<code>central</code> or <code>*,!repo1</code>.
<code>*</code> (since Maven 2.0.5), <code>external:*</code> (since Maven 2.0.9) and <code>external:http:*</code> (since Maven 3.8.0) have
a special meaning: see <a href="/guides/mini/guide-mirror-settings.html">Mirror Settings</a> guide.
]]>
</description>
</field>
<field>
@ -586,7 +591,11 @@
<type>boolean</type>
<defaultValue>false</defaultValue>
<description>
<![CDATA[
Whether this mirror should be blocked from any download request but fail the download process, explaining why.
<br><b>Default value is</b>: <code>false</code>
<br><b>Since</b>: Maven 3.8.0
]]>
</description>
</field>
</fields>

3
maven-artifact/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-builder-support/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-compat/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

11
maven-core/src/main/java/org/apache/maven/bridge/MavenRepositorySystem.java
View File

@ -62,6 +62,7 @@ import org.eclipse.aether.repository.ProxySelector;
import org.eclipse.aether.repository.RemoteRepository;
/**
* @since 3.2.3
*/
@Named("default")
@Singleton
@ -691,11 +692,11 @@ public class MavenRepositorySystem {
/**
* This method checks if the pattern matches the originalRepository. Valid patterns:
* <ul>
* <li>{@code *} = everything,</li>
* <li>{@code external:*} = everything not on the localhost and not file based,</li>
* <li>{@code external:http:*} = any repository not on the localhost using HTTP,</li>
* <li>{@code repo,repo1} = {@code repo} or {@code repo1},</li>
* <li>{@code *,!repo1} = everything except {@code repo1}.</li>
* <li>{@code *} (since 2.0.5)= everything,</li>
* <li>{@code external:*} (since 2.0.9)= everything not on the localhost and not file based,</li>
* <li>{@code external:http:*} (since 3.8.0)= any repository not on the localhost using HTTP,</li>
* <li>{@code repo,repo1} (since 2.0.9)= {@code repo} or {@code repo1},</li>
* <li>{@code *,!repo1} (since 2.0.9)= everything except {@code repo1}.</li>
* </ul>
*
* @param originalRepository to compare for a match.

6
maven-core/src/site/site.xml
View File

@ -33,14 +33,8 @@ under the License.
</menu>
<menu name="Reference">
<item name="Lifecycles" href="lifecycles.html"/>
<item name="Plugin Bindings to Default Lifecycle" href="default-bindings.html"/>
<item name="Artifact Handlers" href="artifact-handlers.html"/>
<item name="Core Extensions" href="core-extensions.html"/>
<item name="Extension Descriptor" href="extension.html"/>
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

7
maven-embedder/src/site/site.xml
View File

@ -31,12 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu name="Reference">
<item name="CLI options" href="cli.html"/>
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

7
maven-model-builder/src/site/site.xml
View File

@ -31,12 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu name="Reference">
<item name="Super POM" href="super-pom.html"/>
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-model/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-plugin-api/src/site/site.xml
View File

@ -35,8 +35,5 @@
<item name="META-INF/maven/lifecycle.xml" href="lifecycle-mappings.html"/>
<item name="META-INF/maven/plugin.xml" href="plugin.html"/>
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-repository-metadata/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-resolver-provider/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-settings-builder/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

12
maven-settings/src/site/apt/index.apt
View File

@ -37,3 +37,15 @@ Maven Settings Model
* A {{{./settings.html}Descriptor Reference}}
* An {{{https://maven.apache.org/xsd/settings-1.2.0.xsd}XSD}}
* See Also User Documentation
* {{{https://maven.apache.org/settings.html} Settings Reference}},
* {{{https://maven.apache.org/guides/mini/guide-mirror-settings.html} Mirror Settings}},
* {{{https://maven.apache.org/guides/mini/guide-deployment-security-settings.html} Security and Deployment Settings}},
* {{{https://maven.apache.org/guides/mini/guide-encryption.html} Password Encryption}},
* {{{https://maven.apache.org/guides/mini/guide-proxies.html} Configuring a proxy}}.

3
maven-settings/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

3
maven-slf4j-provider/src/site/site.xml
View File

@ -31,8 +31,5 @@ under the License.
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>

11
src/site/site.xml
View File

@ -46,25 +46,26 @@ under the License.
<item name="Download" href="/download.html"/>
</menu>
<menu name="Descriptors Reference">
<menu inherit="bottom" name="Descriptors Reference">
<item name="POM" href="./maven-model/maven.html"/>
<item name="Settings" href="./maven-settings/settings.html"/>
<item name="Toolchains" href="./maven-core/toolchains.html"/>
</menu>
<menu name="Reference">
<menu inherit="bottom" name="Reference">
<item name="Lifecycles" href="./maven-core/lifecycles.html"/>
<item name="Plugin Bindings to Default Lifecycle" href="./maven-core/default-bindings.html"/>
<item name="Artifact Handlers" href="./maven-core/artifact-handlers.html"/>
<item name="CLI options" href="./maven-embedder/cli.html"/>
<item name="Super POM" href="./maven-model-builder/super-pom.html"/>
</menu>
<menu name="Development">
<menu inherit="bottom" name="Development">
<item name="Maven Developer Centre" href="../../developers/index.html"/>
<item name="Maven Core ITs" href="../../core-its/index.html"/>
</menu>
<menu ref="modules"/>
<menu ref="reports"/>
<menu inherit="bottom" ref="modules"/>
<menu inherit="bottom" ref="reports"/>
</body>
</project>