[OPENJDK-2009] Move JAVA_OPTIONS specification to s2i/bash module

JAVA_OPTIONS is an old deprecated variable that was replaced by
JAVA_OPTS. If JAVA_OPTS is unset, but JAVA_OPTIONS set, it should
be used to populate JAVA_OPTS, for the images that support it.

The definition of JAVA_OPTIONS was in modules/jvm/api, but the
implementation is in modules/s2i/bash. The former module is included
by the runtime images, that don't use the latter; thus, at the moment
documentation for the runtime images includes JAVA_OPTIONS but they
have never supported it.

Move the definition of JAVA_OPTIONS into the module that implements
it. This removes the definition/documentation from the runtime images.

Rework the descriptions.

Signed-off-by: Jonathan Dowland <[email protected]>

Author: jmtd

modules/jvm/api/module.yaml

@@ -1,4 +1,5 @@
 schema_version: 1
+
 name: jboss.container.java.jvm.api
 version: '1.0'
 description: ^
@@ -16,7 +17,6 @@ envs:
   description:  User specified Java options to be appended to the generated options.
     This variable has no effect if `JAVA_OPTS` has been defined.
   example:      "-Dsome.property=foo"
-  example: "-Dsome.property=foo"
 - name: JAVA_MAX_MEM_RATIO
   description:
     Specify the maximum heap memory. Corresponds to the JVM argument
@@ -73,8 +73,3 @@ envs:
 - name: GC_CONTAINER_OPTIONS
   description: specify Java GC to use. The value of this variable should contain the necessary JRE command-line options to specify the required GC, which will override the default of `-XX:+UseParallelGC`.
   example: -XX:+UseG1GC
-# deprecated
-- name: JAVA_OPTIONS
-  description: JVM options passed to the `java` command.  Use **JAVA_OPTS**.
-  example: "-verbose:class"
-

modules/s2i/bash/module.yaml

@@ -6,6 +6,14 @@ description: Customization of common Maven S2I for Java S2I image.
 envs:
 - name: JBOSS_CONTAINER_JAVA_S2I_MODULE
   value: /opt/jboss/container/java/s2i
+# deprecated
+- name: JAVA_OPTIONS
+  description:
+    If defined and `JAVA_OPTS` is not defined, use this value to
+    populate `JAVA_OPTS`, overriding any JVM tuning parameters
+    generated by the container run scripts.
+    Deprecated. Please use `JAVA_OPTS` instead.
+  example: "-verbose:class"
 
 execute:
 - script: configure.sh