From 2ff4d9ba5201a4ba5f5efe4339288c80976190f7 Mon Sep 17 00:00:00 2001 From: Joshua Suskalo Date: Sat, 9 Oct 2021 08:14:14 -0500 Subject: [PATCH] Add sections on future JDKs and 1.0 release to readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index c750440..940cc4f 100644 --- a/README.md +++ b/README.md @@ -608,6 +608,24 @@ These features are planned for future releases. - Improve error messages from defcfn macro - Mapped memory +### Future JDKs +The purpose of coffi is to provide a wrapper for published versions of Project +Panama, starting with JDK 17. As new JDKs are released, coffi will be ported to +the newer versions of Panama. When JDK 18 is released, a tag will be added to +mark the final release of coffi that is compatible with Java 17, as that is the +LTS release of the JDK. Development of new features and fixes as well as support +for new Panama idioms and features will continue with focus only on the latest +JDK. If a particular feature is not specific to the newer JDK, PRs backporting +it to versions of coffi supporting Java 17 will likely be accepted. + +### 1.0 Release +Because the feature that coffi wraps in the JDK is an incubator feature (and +likely in JDK 19 a [preview +feature](https://mail.openjdk.java.net/pipermail/panama-dev/2021-September/014946.html)) +coffi itself will not be released in a 1.0.x version until the feature becomes a +core part of the JDK, likely before or during the next LTS release, Java 21, in +September 2023. + ## License Copyright © 2021 Joshua Suskalo