[jira] [Created] (MNG-7735) Default configuration file (settings.xml) description is confusing/misleading

["Philippe Cloutier (Jira)" <ji...@apache.org>]

Philippe Cloutier created MNG-7735:
--------------------------------------

             Summary: Default configuration file (settings.xml) description is confusing/misleading
                 Key: MNG-7735
                 URL: https://issues.apache.org/jira/browse/MNG-7735
             Project: Maven
          Issue Type: Improvement
          Components: Settings
            Reporter: Philippe Cloutier
         Attachments: settings_clarification.patch

[The default contents of Maven's settings.xml configuration file|https://gitbox.apache.org/repos/asf?p=maven.git;a=blob_plain;f=apache-maven/src/assembly/maven/conf/settings.xml;hb=HEAD] start with the following comment:
{code:xml}
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user,
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in
 |                 ${maven.conf}/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |–>
{code}

This description is confusing or even misleading in several respects, notably because Maven can have more than 1 configuration file. The attached patch offers fixes/clarifications for these.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)