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

[jira-importer]

Philippe Cloutier opened MNG-7735 and commented

The default contents of Maven's settings.xml configuration file start with the following comment:

<!--
 | 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.
 |
 |–>

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.

---

Attachments:

• settings_clarification.patch (1.43 kB)

[Chealer]

I am this report’s author. This report (including the patch and all my messages in this ticket) is offered under the terms of CC0 1.0.