[MNG-8029] improve documentation of mirror in settings

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.9.6, 4.0.0-alpha-12
• Fix Version/s: 3.9.7, 4.0.0-alpha-13
• Component/s: Documentation: General
• Assignee: Herve Boutemy
• Reporter: Herve Boutemy
• Created: 26/Jan/24 12:44
• Updated: 06/Mar/24 17:53
• Resolved: 17/Feb/24 18:53

Description

reading https://maven.apache.org/ref/3.9.6/maven-settings/settings.html#class_mirror
and comparing to https://maven.apache.org/guides/mini/guide-mirror-settings.html

model documentation does not explain that mirrorOf is not just an id, but has much more flexibility (since Maven versions to be clarified)

and id has no description

it's time to clarify

and also update "reference settings documentation" which is completely obsolete on mirror: https://maven.apache.org/settings.html

Issue Links

• relates to: MNG-2865 Add <mirrorOf>*</mirrorOf> feature
• relates to: MNG-7116 Add support for mirror selector on external:http:*
• relates to: MNG-7117 Add support for blocking mirrors
• relates to: MNG-3461 Enhance Mirror definition syntax with external:*
• relates to: MNG-7980 Add ability to ignore transitive dependency repositories: mvn -itr
• links to: GitHub Pull Request #1395
• links to: Wiki Mirror Settings and File repositories