You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/07/06 15:42:09 UTC
[arrow] branch master updated: MINOR: [Docs][Java] Clarify Java CI and JDK9 flags (#13406)
This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 2c29205b32 MINOR: [Docs][Java] Clarify Java CI and JDK9 flags (#13406)
2c29205b32 is described below
commit 2c29205b32af2a65df3278333583103a17a99972
Author: David Li <li...@gmail.com>
AuthorDate: Wed Jul 6 11:42:02 2022 -0400
MINOR: [Docs][Java] Clarify Java CI and JDK9 flags (#13406)
Clarify the flags required up-front. Note that they're required for JDK9+, not JDK17+. Update the note about which versions are tested in CI.
Authored-by: David Li <li...@gmail.com>
Signed-off-by: David Li <li...@gmail.com>
---
docs/source/java/install.rst | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/docs/source/java/install.rst b/docs/source/java/install.rst
index fac1f90e65..2951dc3959 100644
--- a/docs/source/java/install.rst
+++ b/docs/source/java/install.rst
@@ -28,7 +28,13 @@ Java modules are regularly built and tested on macOS and Linux distributions.
Java Compatibility
------------------
-Java modules are currently compatible with JDK 8, 9, 10, 11, 17, and 18, but only JDK 11 is tested in CI.
+Java modules are currently compatible with JDK 8, 9, 10, 11, 17, and 18.
+Currently, JDK 8, 11, 17, and 18 are tested in CI.
+
+When using Java 9 or later, some JDK internals must be exposed by
+adding ``--add-opens=java.base/java.nio=ALL-UNNAMED``. Otherwise,
+you may see errors like ``module java.base does not "opens
+java.nio" to unnamed module``.
Installing from Maven
---------------------
@@ -101,12 +107,7 @@ transitive dependencies of Flight.
</build>
</project>
-When using Java 17 or later, some JDK internals must be exposed by
-adding ``--add-opens=java.base/java.nio=ALL-UNNAMED``. Otherwise,
-you may see errors like ``module java.base does not "opens
-java.nio" to unnamed module``.
-
-For example, when running unit tests through Maven:
+The ``--add-opens`` flag can be added when running unit tests through Maven:
.. code-block::
@@ -123,7 +124,7 @@ For example, when running unit tests through Maven:
</plugins>
</build>
-Environment variables: To execute your Arrow Java main code.
+Or they can be added via environment variable, for example when executing your code:
.. code-block::