Skip to content

Commit af7c344

Browse files
committed
Update README
1 parent bfb9bf2 commit af7c344

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ Unofficial JDK Classfile API Backport
55

66
This is a backport to JDK 17 of the new classfile API found in JDK 21 and later.
77

8-
Bugs in this project should be reported to https://github.com/dmlloyd/jdk-classfile-backport/issues first. Bugs in this project are likely to be a result of backporting. Some bugs might be relayed upstream by the project maintainer(s), subject to testing and verification; in this case, the upstream bug will be linked for easier tracking.
8+
Bugs in this project should be reported to [the GitHub issue tracker](https://github.com/dmlloyd/jdk-classfile-backport/issues) first. Bugs in this project are likely to be a result of backporting. Some bugs might be relayed upstream by the project maintainer(s), subject to testing and verification; in this case, the upstream bug will be linked for easier tracking.
99

1010
Releases
1111
--------
1212

13-
Releases of the project roughly track releases of the corresponding JDK from which it is backported. This means that version 23.x of this project corresponds to the state of the upstream classfile API in JDK 23, and so on.
13+
Releases of the project roughly track releases of the corresponding JDK from which it is backported. This means that version 24.x of this project corresponds to the state of the upstream classfile API in JDK 24, and so on.
1414

15-
The upstream classfile API is expected to leave preview for Java 24. At that time, it is expected that binary compatibility will be maintained with a strictness corresponding to that of the upstream API. Until then, there can (and will) be various API breakages which occur between major versions. Keep this in mind when planning integration into new projects.
15+
Binary compatibility is maintained with a strictness corresponding to that of the upstream API.
1616

17-
It is currently planned to continue to backport features from Java versions beyond 24. The major version of this project will continue to correspond to the JDK from which the changes were backported. When planning a transition from this library to the official API, be sure that the major version of this library corresponds to the target JDK to avoid a situation where you start using features which are not available in the JDK version you want to target, causing difficulties when migrating.
17+
It is currently planned to continue to backport features indefinitely. The major version of this project will continue to correspond to the JDK from which the changes were backported. When planning a transition from this library to the official API, be sure that the major version of this library corresponds to the target JDK to avoid a situation where you start using features which are not available in the JDK version you want to target, causing difficulties when migrating.
1818

19-
The release schedule is fairly ad-hoc and irregular. If you encounter a bug which has been fixed in this project but not yet released, feel free to open an issue to request a release.
19+
The release schedule is fairly ad-hoc and irregular, but will generally align with that of the upstream JDK. If you encounter a bug which has been fixed in this project but not yet released, feel free to open an issue to request a release.
2020

2121
Getting started
2222
---------------
@@ -38,3 +38,10 @@ byte[] b = ClassFile.of().build(classDesc, classBuilder -> {
3838
// ... build the class here ...
3939
});
4040
```
41+
More information
42+
----------------
43+
44+
For more information on this API, see:
45+
46+
* [JEP 484](https://openjdk.org/jeps/484)
47+
* [The official upstream documentation at Oracle](https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/classfile/package-summary.html)

0 commit comments

Comments
 (0)