(maven-site) 01/01: Clarify default values for repositories

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch bugfix/improve-pom-repositories-section
in repository https://gitbox.apache.org/repos/asf/maven-site.git

commit 7873ffde3ec663c0fc2b27c296a9d706ac9ee231
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Jan 15 10:45:40 2024 +0100

    Clarify default values for repositories
    
    Clean up example snippet for repositories
---
 content/apt/pom.apt.vm | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/content/apt/pom.apt.vm b/content/apt/pom.apt.vm
index af5fbc69..c4e89c80 100644
--- a/content/apt/pom.apt.vm
+++ b/content/apt/pom.apt.vm
@@ -1710,12 +1710,10 @@ scm:cvs:pserver:127.0.0.1:/cvs/root:my-project
     <repository>
       <releases>
         <enabled>false</enabled>
-        <updatePolicy>always</updatePolicy>
-        <checksumPolicy>warn</checksumPolicy>
       </releases>
       <snapshots>
         <enabled>true</enabled>
-        <updatePolicy>never</updatePolicy>
+        <updatePolicy>always</updatePolicy>
         <checksumPolicy>fail</checksumPolicy>
       </snapshots>
       <name>Nexus Snapshots</name>
@@ -1738,7 +1736,7 @@ scm:cvs:pserver:127.0.0.1:/cvs/root:my-project
 
   * <<enabled>>:
   <<<true>>> or <<<false>>> for whether this repository is enabled for the respective
-  type (<<<releases>>> or <<<snapshots>>>).
+  type (<<<releases>>> or <<<snapshots>>>). By default this is <<<true>>>.
 
   * <<updatePolicy>>:
   This element specifies how often updates should attempt to occur. Maven will compare the local
@@ -1748,12 +1746,21 @@ scm:cvs:pserver:127.0.0.1:/cvs/root:my-project
 
   * <<checksumPolicy>>:
   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.
+  are to <<<ignore>>>, <<<fail>>>, or <<<warn>>> on missing or incorrect checksums. The default value is <<<warn>>>.
+
+  * <<id>>:
+  The repository id is mandatory and connects the repository with the servers from <<<settings.xml>>>. Its default value is <<<default>>>.
+  Also the id is used is the {{{https://maven.apache.org/ref/3-LATEST/maven-repository-metadata/}local repository metadata}} to store the original source.
+
+  * <<name>>:
+  An optional name for the repository. Used as label when emitting log messages related to this repository.
 
   * <<layout>>:
   In the above description of repositories, it was mentioned that they all follow a common layout. This
   is mostly correct. The layout introduced with Maven 2 is the default layout for repositories used by Maven both 2 & 3.
-  However, Maven 1.x had a different layout. Use this element to specify whether it is <<<default>>> or <<<legacy>>>.
+  However, Maven 1.x had a different layout. Use this element to specify whether it is <<<default>>> or <<<legacy>>>. 
+  Its default value is <<<default>>>.
+
 
 * {Plugin Repositories}