Skip to content

Commit cdd2d3c

Browse files
committed
[OPENJDK-2064] Clarify permitted format for MAVEN_REPOS
Expand the documentation for MAVEN_REPOS to make it clear that it must be specified in uppercase, and that hyphens/dashes are replaced by underscores. Signed-off-by: Jonathan Dowland <[email protected]>
1 parent 662e0e8 commit cdd2d3c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

modules/maven/api/module.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,15 @@ envs:
3636
description: Directory to use as the local Maven repository.
3737
example: /home/jboss/.m2/repository
3838
- name: "MAVEN_REPOS"
39-
example: "dev-one,qe-two"
40-
description: "If set, multi-repo support is enabled, and other MAVEN_REPO_* variables will be prefixed. For example: DEV_ONE_MAVEN_REPO_URL and QE_TWO_MAVEN_REPO_URL"
39+
example: "DEV-ONE,QE-TWO"
40+
description: >
41+
Enables multi-repo support. Specify a comma-delimited list of capitalized
42+
repository identifiers. The configuration for each repository will be
43+
determined by correspondingly prefixed `MAVEN_REPO_*` variables. Any dashes
44+
in repository names will be replaced with underscores. For example:
45+
Specifying `DEV-ONE,QE-TWO` configures two repositories and their
46+
URLs will be read from `DEV_ONE_MAVEN_REPO_URL` and
47+
`QE_TWO_MAVEN_REPO_URL`.
4148
- name: "prefix_MAVEN_REPO_ID"
4249
example: "my-repo-id"
4350
description: "Maven repository id"

0 commit comments

Comments
 (0)