This is an automated email from the ASF dual-hosted git repository. leerho pushed a commit to branch minor_corrections_to_main in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git
commit 3a926facf7d47a2128b8aa40ed96967b5ad51600 Author: Lee Rhodes <[email protected]> AuthorDate: Mon Jan 6 18:12:30 2025 -0800 Minor corrections to NOTICE, pom.xml, and README.md --- NOTICE | 2 +- README.md | 23 ++++++++++++++++------- pom.xml | 4 ++-- 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/NOTICE b/NOTICE index 578c487..d35ff24 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,5 @@ Apache DataSketches Memory -Copyright 2024 - The Apache Software Foundation +Copyright 2025 - The Apache Software Foundation Copyright 2015-2018 Yahoo Inc. Copyright 2019-2020 Verizon Media diff --git a/README.md b/README.md index cbe9bed..6f16e62 100644 --- a/README.md +++ b/README.md @@ -63,15 +63,18 @@ Note: *primitive* := *{byte, short, int, long, float, double}* * *WritableMemory.writableWrap(ByteBuffer.allocateDirect(int))* * **Off-Heap, Memory-Mapped Files** - * *Memory.map(File)* (read only) + * *Memory.map(File, Arena)* (read only) * *WritableMemory.writableMap(File)* ## Release 5.0.0 (inclusive) to 6.0.0 (exclusive) -Starting with release *datasketches-memory-5.0.0*, this Memory component supports only Java 21 when compiling from source and should work with later Java versions at runtime. +Starting with release *datasketches-memory-5.0.0*, this Memory component supports only Java 21 when compiling from source and may work with later Java versions at runtime. -### *NOTES:* +### Runtime Notes: +* There are no run-time dependencies. * The DataSketches Java Memory Component is not thread-safe. +* This Release, based on Java 21, leverages the new Java Foreign Function & Memory (FFM) API [JEP 442](https://openjdk.org/jeps/442), which is in its third Preview and will require the JVM flag *--enable-preview* at run-time. * We recommend Eclipse Adoptium/Temurin 21.0.5+11 or later as earlier releases of 21 have bugs that affect this product. +* This component is not designed as a Java Module, so the Jar file should be part of the application classpath. ## Build Instructions __NOTES:__ @@ -80,15 +83,21 @@ __NOTES:__ 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) -* The compile command line must contain the JVM flag *--enable-preview*. -* This component is not designed as a Java Module, so the Jar file should be part of the application classpath. +* The compile command line must contain the JVM flag *--enable-preview* (see [JEP 442](https://openjdk.org/jeps/442)). + + +#### Build & Test Dependencies +* There are two direct build dependencies, both of which are only used in *test scope*: + * org.testng/testng + * net.openhft/zero-allocation-hashing +* See the pom.xml file for maven plug-in dependencies. -#### Dependencies -There are no run-time dependencies. See the pom.xml file for test dependencies. #### Maven build instructions The Maven build requires JDK-21 to compile: +* We recommend Eclipse Adoptium/Temurin 21.0.5+11 or later as earlier releases of 21 have bugs that affect this product. + To run normal unit tests: mvn clean test diff --git a/pom.xml b/pom.xml index 9e33d2b..c8dc5bb 100644 --- a/pom.xml +++ b/pom.xml @@ -108,7 +108,7 @@ under the License. <maven-gpg-plugin.version>3.2.7</maven-gpg-plugin.version> <maven-install-plugin.version>3.1.2</maven-install-plugin.version> <maven-jar-plugin.version>3.4.2</maven-jar-plugin.version> - <maven-javadoc-plugin.version>3.11.1</maven-javadoc-plugin.version> + <maven-javadoc-plugin.version>3.11.2</maven-javadoc-plugin.version> <maven-release-plugin.version>3.1.1</maven-release-plugin.version> <maven-remote-resources-plugin.version>3.2.0</maven-remote-resources-plugin.version> <maven-source-plugin.version>3.3.1</maven-source-plugin.version> @@ -124,7 +124,7 @@ under the License. <!-- org.jacoco.maven plugins --> <jacoco-maven-plugin.version>0.8.12</jacoco-maven-plugin.version> <!-- org.mojohaus plugins --> - <versions-maven-plugin.version>2.17.1</versions-maven-plugin.version> + <versions-maven-plugin.version>2.18.0</versions-maven-plugin.version> <!-- other --> <lifecycle-mapping.version>1.0.0</lifecycle-mapping.version> <zero-allocation-hashing.version>0.16</zero-allocation-hashing.version> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
