Skip to content

Commit 11900bd

Browse files
committed
Updated README.md.
1 parent f3a4025 commit 11900bd

1 file changed

Lines changed: 8 additions & 16 deletions

File tree

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ This is the core Java component of the DataSketches library. It contains all of
2727

2828
This component is also a dependency of other components of the library that create adaptors for target systems, such as the [Apache Pig adaptor](https://github.com/apache/datasketches-pig), the [Apache Hive adaptor](https://github.com/apache/datasketches-hive), and others.
2929

30-
Note that we have a parallel core component for C++ and Python implementations of many of the same sketch algorithms,
31-
[datasketches-cpp](https://github.com/apache/datasketches-cpp) and [datasketches-python](https://github.com/apache/datasketches-python)
30+
Note that we have a parallel core component for C++, Python and GO implementations of many of the same sketch algorithms,
31+
[datasketches-cpp](https://github.com/apache/datasketches-cpp), [datasketches-python](https://github.com/apache/datasketches-python), and
32+
[datasketches-go](https://github.com/apache/datasketches-go).
3233

3334
Please visit the main [DataSketches website](https://datasketches.apache.org) for more information.
3435

@@ -41,28 +42,19 @@ If you are interested in making contributions to this site please see our [Commu
4142
### Installation Directory Path
4243
**NOTE:** This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements. This is required by the Oracle Java Specification in order to ensure location-independent access to resources: [See Oracle Location-Independent Access to Resources](https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html)
4344

44-
### OpenJDK Version 21
45-
An OpenJDK-compatible build of Java 21, provided by one of the Open-Source providers, such as Azul Systems, Red Hat, SAP, Eclipse Temurin, etc, is required.
45+
### OpenJDK Version 24
46+
An OpenJDK-compatible build of Java 24, provided by one of the Open-Source JVM providers, such as Azul Systems, Red Hat, SAP, Eclipse Temurin, etc, is required.
4647
All of the testing of this release has been performed with an Eclipse Temurin build.
4748

48-
This release uses the new Java Foreign Function & Memory (FFM) features that are in "preview" in Java 21.
49-
As a result, the JVM flag <nobr>**--enable-preview**</nobr> must be set at compile and at runtime.
50-
51-
**NOTE:** OpenJDK versions greater than 21 do not support running Java 21 class files (Class ID 65) with preview code. The runtime JVM version must be 21.
52-
53-
**NOTE:** The Eclipse Compiler for Java (ECJ) version 21, used by default in both the Eclipse JDT IDE and the VScode IDE, will not allow compilation of preview code for Java version 21. Both Eclipse and VScode can be configured to use an OpenJDK compiler instead, but you will loose the incremental build capability of the ECJ.
54-
55-
### DataSketches Memory 6.0.0
56-
57-
This component depends on the [datasketches-memory-6.0.0](https://github.com/apache/datasketches-memory/tree/6.0.0) component,
49+
This release uses the new Java Foreign Function & Memory (FFM) features that were made part of the Java Language in in Java 22.
5850

5951
## Compilation and Test using Maven
6052
This DataSketches component is structured as a Maven project and Maven is the recommended tool for compile and test.
6153

6254
#### A Toolchain is required
6355

64-
* You must have a JDK type toolchain defined in location *~/.m2/toolchains.xml* that specifies where to find a locally installed OpenJDK-compatible version 21.
65-
* Your default \$JAVA\_HOME compiler must be OpenJDK compatible, specified in the toolchain, and may be a version greater than 21. Note that if your \$JAVA\_HOME is set to a Java version greater than 21, Maven will automatically use the Java 21 version specified in the toolchain instead. The included pom.xml specifies the necessary JVM flags, so no further action should be required.
56+
* You must have a JDK type toolchain defined in location *~/.m2/toolchains.xml* that specifies where to find a locally installed OpenJDK-compatible version 24.
57+
* Your default \$JAVA\_HOME compiler must be OpenJDK compatible, specified in the toolchain, and may be a version greater than 24. Note that if your \$JAVA\_HOME is set to a Java version greater than 24, Maven will automatically use the Java 24 version specified in the toolchain instead. The included pom.xml specifies the necessary JVM flags, so no further action should be required.
6658
* Note that the paths specified in the toolchain must be fully qualified direct paths to the OpenJDK version locations. Using environment variables will not work.
6759

6860
#### To run normal unit tests:

0 commit comments

Comments
 (0)