This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory.git
The following commit(s) were added to refs/heads/main by this push:
new 24ca8e41e docs(java): clarify JDK 25 module opening recommendation
(#3922)
24ca8e41e is described below
commit 24ca8e41ebf3a67f8cb15490b0718050e22f21d3
Author: Shawn Yang <[email protected]>
AuthorDate: Tue Aug 4 23:57:02 2026 +0800
docs(java): clarify JDK 25 module opening recommendation (#3922)
<!--
**Thanks for contributing to Apache Fory™.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory™** community has requirements on the naming of pr
titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Apache Fory™ has a strong focus on performance. If the PR you submit
will have an impact on performance, please benchmark it first and
provide the benchmark result here.
-->
## Why?
<!-- Describe the purpose of this PR. -->
## What does this PR do?
<!-- Describe the details of this PR. -->
## Related issues
<!--
Is there any related issue? If this PR closes them you say say
fix/closes:
- #xxxx0
- #xxxx1
- Fixes #xxxx2
-->
## AI Contribution Checklist
<!-- Full requirements and disclosure template:
https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs
-->
- [ ] Substantial AI assistance was used in this PR: `yes` / `no`
- [ ] If `yes`, I included a completed [AI Contribution
Checklist](https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs)
in this PR description and the required `AI Usage Disclosure`.
- [ ] If `yes`, my PR description includes the required `ai_review`
summary and screenshot evidence or equivalent persisted links of the
final clean AI review results from both fresh reviewers described in
`AI_POLICY.md`, the Fory-guided reviewer and the independent general
reviewer, on the current PR diff or current HEAD after the latest code
changes.
<!-- If substantial AI assistance = `yes`, paste the completed checklist
and disclosure block here, including the final ai_review summary and
screenshot evidence or equivalent persisted links from both fresh
reviewers described in AI_POLICY.md, the Fory-guided reviewer and the
independent general reviewer, on the current PR diff or current HEAD
after the latest code changes. -->
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
Delete section if not applicable.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
Delete section if not applicable.
-->
---
README.md | 2 +-
docs/json/getting-started.md | 2 +-
docs/object-serialization/java/index.md | 2 +-
docs/object-serialization/java/troubleshooting.md | 2 +-
docs/object-serialization/kotlin/index.md | 2 +-
docs/object-serialization/scala/index.md | 2 +-
java/README.md | 2 +-
java/fory-json/README.md | 2 +-
8 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6951de374..c4bbca795 100644
--- a/README.md
+++ b/README.md
@@ -160,7 +160,7 @@ Gradle:
implementation "org.apache.fory:fory-core:1.5.0"
```
-On JDK25+, opening `java.lang.invoke` to Fory core is not required, but is
recommended. It avoids the
+On JDK25+, opening `java.lang.invoke` to Fory core is also recommended. It
avoids the
current-JDK Unsafe fallback and is required when Unsafe access is disabled or
unavailable, including
with `--sun-misc-unsafe-memory-access=deny`. Use `ALL-UNNAMED` when Fory is on
the classpath:
diff --git a/docs/json/getting-started.md b/docs/json/getting-started.md
index 4c451f743..73554f955 100644
--- a/docs/json/getting-started.md
+++ b/docs/json/getting-started.md
@@ -46,7 +46,7 @@ Use the same version for every Fory module in one application.
### JDK 25 and later
-On JDK 25 and later, opening `java.lang.invoke` to Fory core is not required,
but is recommended. It avoids
+On JDK 25 and later, opening `java.lang.invoke` to Fory core is also
recommended. It avoids
the current-JDK Unsafe fallback and is required when Unsafe access is disabled
or unavailable,
including with `--sun-misc-unsafe-memory-access=deny`. For a classpath
application:
diff --git a/docs/object-serialization/java/index.md
b/docs/object-serialization/java/index.md
index 15fadb9c4..c01240592 100644
--- a/docs/object-serialization/java/index.md
+++ b/docs/object-serialization/java/index.md
@@ -76,7 +76,7 @@ implementation("org.apache.fory:fory-core:1.5.0")
#### JDK 25 and Later
-On JDK 25 and later, opening `java.lang.invoke` to Fory core is not required,
but is recommended. It avoids
+On JDK 25 and later, opening `java.lang.invoke` to Fory core is also
recommended. It avoids
the current-JDK Unsafe fallback and is required when Unsafe access is disabled
or unavailable,
including with `--sun-misc-unsafe-memory-access=deny`. Use `ALL-UNNAMED` when
Fory is on the
classpath:
diff --git a/docs/object-serialization/java/troubleshooting.md
b/docs/object-serialization/java/troubleshooting.md
index d70a02755..86e006319 100644
--- a/docs/object-serialization/java/troubleshooting.md
+++ b/docs/object-serialization/java/troubleshooting.md
@@ -185,7 +185,7 @@ fory.registerSerializer(MyClass.class, new
MyClassSerializer(fory.getTypeResolve
### JDK25+ access errors
-On JDK25+, opening `java.lang.invoke` to Fory core is not required, but is
recommended. Add the opening if
+On JDK25+, opening `java.lang.invoke` to Fory core is also recommended. Add
the opening if
an error names `java.base/java.lang.invoke`, or when Unsafe access is disabled
or unavailable,
including with `--sun-misc-unsafe-memory-access=deny`. Use `ALL-UNNAMED` when
Fory is on the
classpath:
diff --git a/docs/object-serialization/kotlin/index.md
b/docs/object-serialization/kotlin/index.md
index 77dda3e8c..991117292 100644
--- a/docs/object-serialization/kotlin/index.md
+++ b/docs/object-serialization/kotlin/index.md
@@ -66,7 +66,7 @@ implementation("org.apache.fory:fory-kotlin:1.5.0")
### JDK25+
Kotlin uses the Fory Java core when running. On JDK25+, opening
`java.lang.invoke` to Fory core is
-not required, but is recommended. It avoids the current-JDK Unsafe fallback
and is required when Unsafe
+also recommended. It avoids the current-JDK Unsafe fallback and is required
when Unsafe
access is disabled or unavailable, including with
`--sun-misc-unsafe-memory-access=deny`. Use
`ALL-UNNAMED` when Fory is on the classpath:
diff --git a/docs/object-serialization/scala/index.md
b/docs/object-serialization/scala/index.md
index 7a10630b6..733725d95 100644
--- a/docs/object-serialization/scala/index.md
+++ b/docs/object-serialization/scala/index.md
@@ -55,7 +55,7 @@ libraryDependencies += "org.apache.fory" %% "fory-scala" %
"1.5.0"
### JDK25+
Scala uses the Fory Java core when running. On JDK25+, opening
`java.lang.invoke` to Fory core is
-not required, but is recommended. It avoids the current-JDK Unsafe fallback
and is required when Unsafe
+also recommended. It avoids the current-JDK Unsafe fallback and is required
when Unsafe
access is disabled or unavailable, including with
`--sun-misc-unsafe-memory-access=deny`. Use
`ALL-UNNAMED` when Fory is on the classpath:
diff --git a/java/README.md b/java/README.md
index e9a3e9a2b..4d92bc446 100644
--- a/java/README.md
+++ b/java/README.md
@@ -137,7 +137,7 @@ dependencies {
### JDK25+
-On JDK25+, opening `java.lang.invoke` to Fory core is not required, but is
recommended. It avoids the
+On JDK25+, opening `java.lang.invoke` to Fory core is also recommended. It
avoids the
current-JDK Unsafe fallback and is required when Unsafe access is disabled or
unavailable, including
with `--sun-misc-unsafe-memory-access=deny`. Use `ALL-UNNAMED` when Fory is on
the classpath:
diff --git a/java/fory-json/README.md b/java/fory-json/README.md
index 0e46a6d4f..e3af227d8 100644
--- a/java/fory-json/README.md
+++ b/java/fory-json/README.md
@@ -52,7 +52,7 @@ Gradle:
implementation("org.apache.fory:fory-json:1.5.0")
```
-On JDK 25 and later, opening `java.lang.invoke` to Fory core is not required,
but is recommended. It avoids
+On JDK 25 and later, opening `java.lang.invoke` to Fory core is also
recommended. It avoids
the current-JDK Unsafe fallback and is required when Unsafe access is disabled
or unavailable,
including with `--sun-misc-unsafe-memory-access=deny`. Use `ALL-UNNAMED` on
the classpath:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]