Skip to content

Commit e10b056

Browse files
committed
[OPENJDK-1963] document MAVEN_MIRRORS upcasing behaviour
rewrite description of MAVEN_MIRRORS to properly document the format of the parameter (uppercase, dashes get replaced with underscores). Signed-off-by: Jonathan Dowland <[email protected]>
1 parent fdec14b commit e10b056

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

modules/maven/default/module.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,16 @@ envs:
4242
Defaults to "external:*".
4343
example: external:*
4444
- name: MAVEN_MIRRORS
45-
description: "If set, multi-mirror support is enabled, and other MAVEN_MIRROR_* variables will be prefixed. For example: DEV_ONE_MAVEN_MIRROR_URL and QE_TWO_MAVEN_MIRROR_URL"
46-
example: "dev-one,qe-two"
45+
description: >
46+
Enables multi-mirror support. Specify a comma-delimited list of capitalized
47+
mirror identifiers. The configuration for each mirror will be determined by
48+
correspondingly prefixed `MAVEN_MIRROR_*` variables. Any dashes in mirror
49+
names will be replaced by underscores. For example: Specifying
50+
`DEV-ONE,QE-TWO` configures two mirrors and their URLs will be read from
51+
the `DEV_ONE_MAVEN_MIRROR_URL` and `QE_TWO_MAVEN_MIRROR_URL` variables.
52+
See also: `prefix_MAVEN_MIRROR_ID`; `prefix_MAVEN_MIRROR_OF`;
53+
`prefix_MAVEN_MIRROR_URL`.
54+
example: "DEV-ONE,QE-TWO"
4755
- name: prefix_MAVEN_MIRROR_ID
4856
description: "ID to be used for the specified mirror. If omitted, a unique ID will be generated."
4957
example: "internal-mirror"

0 commit comments

Comments
 (0)