diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /jvmfwk | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (diff) | |
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/
Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'jvmfwk')
| -rw-r--r-- | jvmfwk/README.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/jvmfwk/README.md b/jvmfwk/README.md index 7cb338e14f32..b21540851683 100644 --- a/jvmfwk/README.md +++ b/jvmfwk/README.md @@ -1,15 +1,20 @@ +# JVM Framework Wrappers + 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 +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 +message of <https://gerrit.libreoffice.org/#/c/69730/> in LibreOffice gerrit: + +"**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 +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." |