[OPENJDK-2388] document MAVEN_MIRROR_OF

Document the MAVEN_MIRROR_OF configuration variable. Reference MAVEN_MIRRORS, for multi-mirror configuration. Also reference MAVEN_MIRRORS in the documentation for MAVEN_MIRROR_URL. Signed-off-by: Jonathan Dowland <[email protected]>
rh-openjdk · Oct 25, 2023 · d20eee3 · d20eee3
1 parent 0a41ced
commit d20eee3
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/modules/maven/api/module.yaml b/modules/maven/api/module.yaml
@@ -16,8 +16,16 @@ envs:
 - name: MAVEN_CLEAR_REPO
   description: If set then the Maven repository is removed after the artifact is built. This is useful for keeping the created application image small, but prevents *incremental* builds. Will be overridden by **S2I_ENABLE_INCREMENTAL_BUILDS**.  Defaults to *false*.
 - name: MAVEN_MIRROR_URL
-  description: The base URL of a mirror used for retrieving artifacts.
+  description: >
+    The base URL of a mirror used for retrieving artifacts.
+    For multi-mirror support, see  `MAVEN_MIRRORS`.
   example: "http://10.0.0.1:8080/repository/internal/"
+- name: MAVEN_MIRROR_OF
+  description: >
+    Repository IDs mirrored by the mirror specified in `MAVEN_MIRROR_URL`.
+    For multi-mirror support, see  `MAVEN_MIRRORS`.
+    Defaults to "external:*".
+  example: external:*
 - name: MAVEN_MIRRORS
   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"
   example: "dev-one,qe-two"