summaryrefslogtreecommitdiff
path: root/jvmfwk/README.md
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-23 14:20:32 +0430
committerChristian Lohmaier <lohmaier+LibreOffice@googlemail.com>2021-03-24 11:46:14 +0100
commitc16158772d64cab8a4ed1f165cab57d307998e78 (patch)
tree424f72af3b4a877ecb9493cd64de70e4925a9bee /jvmfwk/README.md
parentea184837a54fc85599d78baf59c83b6cf8bd0adb (diff)
Using .md extension/Markdown syntax for modules README
Renaming all README files for all top level modules to README.md, applying no content change at this stage to be able to track history of the files. These files should be edited to use correct Markdown syntax later. Change-Id: I542fa3f3d32072156f16eaad2211a397cc212665 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/112977 Tested-by: Jenkins Reviewed-by: Christian Lohmaier <lohmaier+LibreOffice@googlemail.com>
Diffstat (limited to 'jvmfwk/README.md')
-rw-r--r--jvmfwk/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/jvmfwk/README.md b/jvmfwk/README.md
new file mode 100644
index 000000000000..7cb338e14f32
--- /dev/null
+++ b/jvmfwk/README.md
@@ -0,0 +1,15 @@
+Wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with more ease.
+
+Used to use an over-engineered "plugin" mechanism although there was only one
+"plugin", called "sunmajor", that handles all possible JREs.
+
+IMPORTANT: The <updated> element in vmfwk/distributions/OpenOfficeorg/javavendors_*.xml files
+should only be updated for incompatible changes, not for compatible ones. As stated in the commit
+message of <https://gerrit.libreoffice.org/#/c/69730/> "javavendors_*.xml <updated> should not have
+been updated...": "Changing <updated> causes jfw_startVM and jfw_getSelectedJRE (both
+jvmfwk/source/framework.cxx) to fail with JFW_E_INVALID_SETTINGS, which in turn causes functionality
+that requires a JVM to issue a GUI error dialog stating that the user must select a new JRE in the
+Options dialog. While that behavior makes sense if a JRE was selected that would no longer be
+supported by the modified javavendors_*.xml, it is just annoying if an already selected JRE is still
+supported. And a compatible change to javavendors_*.xml implies that an already selected JRE will
+still be supported."