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 4b1d113b0 chore: add trademark for fory name (#2590)
4b1d113b0 is described below
commit 4b1d113b00fb202470663f002e4f4b585430e858
Author: Shawn Yang <[email protected]>
AuthorDate: Mon Sep 8 15:46:57 2025 +0800
chore: add trademark for fory name (#2590)
<!--
**Thanks for contributing to 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).
- 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
-->
## 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.
-->
---
.github/pull_request_template.md | 6 +++---
CONTRIBUTING.md | 12 ++++++------
NOTICE | 2 +-
README.md | 14 +++++++-------
cpp/README.md | 4 ++--
dart/README.md | 18 +++++++++---------
dart/packages/fory-test/README.md | 4 ++--
dart/packages/fory/README.md | 16 ++++++++--------
docs/README.md | 2 +-
docs/cpp_debug.md | 4 ++--
docs/guide/DEVELOPMENT.md | 16 ++++++++--------
docs/guide/graalvm_guide.md | 4 ++--
docs/guide/row_format_guide.md | 2 +-
docs/guide/scala_guide.md | 4 ++--
docs/specification/java_serialization_spec.md | 12 ++++++------
docs/specification/row_format_spec.md | 2 +-
docs/specification/xlang_serialization_spec.md | 14 +++++++-------
integration_tests/cpython_benchmark/README.md | 6 +++---
java/benchmark/README.md | 10 +++++-----
java/fory-core/src/main/resources/META-INF/NOTICE | 2 +-
java/fory-format/src/main/resources/META-INF/NOTICE | 2 +-
kotlin/README.md | 14 +++++++-------
python/CONTRIBUTING.md | 2 +-
python/README.md | 8 ++++----
rust/README.md | 10 +++++-----
scala/README.md | 2 +-
scala/build.sbt | 4 ++--
27 files changed, 98 insertions(+), 98 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 10c620545..950f23dd1 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,13 +1,13 @@
<!--
-**Thanks for contributing to Fory.**
+**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).
+ - 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).
- - 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.
+ - 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?
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3b95d986c..99688f70b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# How to contribute to Fory
+# How to contribute to Apache Fory™
## Finding good first issues
@@ -19,9 +19,9 @@ For example, here are good PR titles:
- fix(c++): blablabla
- chore(python): remove useless yyy file
-If the submitted PR affects the performance of Fory, we strongly recommend
using the perf type,
+If the submitted PR affects the performance of Apache Fory™, we strongly
recommend using the perf type,
and need to provide benchmark data in the PR description. For how to run the
benchmark,
-please check [Fory Java
Benchmark](https://github.com/apache/fory/blob/main/java/benchmark/README.md).
+please check [Apache Fory™ Java
Benchmark](https://github.com/apache/fory/blob/main/java/benchmark/README.md).
For more details, please check [pr-lint.yml](./.github/workflows/pr-lint.yml).
@@ -135,7 +135,7 @@ npm run lint
### Java
-Fory supports dump jit generated code into local file for better debug by
configuring environment variables:
+Apache Fory™ supports dump jit generated code into local file for better debug
by configuring environment variables:
- `FORY_CODE_DIR`：The directory for fory to dump generated code. Set to empty
by default to skip dump code.
- `ENABLE_FORY_GENERATED_CLASS_UNIQUE_ID`: Append an unique id for dynamically
generated files by default to avoid serializer collision for different classes
with same name. Set this to `false` to keep serializer name same for multiple
execution or `AOT` codegen.
@@ -198,7 +198,7 @@ bazel run :refresh_compile_commands
## How to use Jetbrains IDEA IDE for Java Development
-Apache Fory Java development is based on Java 11+, and different modules are
built with different Java versions.
+Apache Fory™ Java development is based on Java 11+, and different modules are
built with different Java versions.
For example, the `fory-core` module is built with Java 8, and the
`fory-format` module is built with Java 11.
@@ -212,7 +212,7 @@ And due to the usage of `sun.misc.Unsafe` API, which is not
visible in Java 11+,
## Website
-Fory's website consists of static pages hosted at
https://github.com/apache/fory-site.
+Apache Fory™'s website consists of static pages hosted at
https://github.com/apache/fory-site.
All updates about docs under [guide](docs/guide) and
[benchmarks](docs/benchmarks) will be synced to the site repo automatically.
diff --git a/NOTICE b/NOTICE
index fe7979ed8..d6dfd06fd 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1,4 +1,4 @@
-Apache Fory
+Apache Fory™
Copyright 2023-2025 The Apache Software Foundation
This product includes software developed at
diff --git a/README.md b/README.md
index 71bc96660..0a7097707 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,12 @@
[](https://x.com/ApacheFory)
[](https://search.maven.org/#search|gav|1|g:"org.apache.fory"%20AND%20a:"fory-core")
-**Apache Fory** is a blazingly-fast multi-language serialization framework
powered by **JIT** (just-in-time compilation) and **zero-copy**, providing up
to 170x performance and ultimate ease of use.
+**Apache Fory™** is a blazingly-fast multi-language serialization framework
powered by **JIT** (just-in-time compilation) and **zero-copy**, providing up
to 170x performance and ultimate ease of use.
<https://fory.apache.org>
> [!IMPORTANT]
-> **Apache Fory was previously named as Apache Fury. For versions before 0.11,
please use "fury" instead of "fory" in package names, imports, and
dependencies, see [Fury
Docs](https://fory.apache.org/docs/0.10/docs/introduction/) for how to use Fury
in older versions**.
+> **Apache Fory™ was previously named as Apache Fury. For versions before
0.11, please use "fury" instead of "fory" in package names, imports, and
dependencies, see [Fury
Docs](https://fory.apache.org/docs/0.10/docs/introduction/) for how to use Fury
in older versions**.
## Features
@@ -26,7 +26,7 @@
- reduce hash lookup.
- **Multiple binary protocols**: Object graph, row format, and so on.
-In addition to cross-language serialization, Fory also features at:
+In addition to cross-language serialization, Apache Fory™ also features at:
- Drop-in replace Java serialization frameworks such as JDK/Kryo/Hessian, but
100x faster at most, which can greatly improve
the efficiency of high-performance RPC calls, data transfer, and object
persistence.
@@ -40,7 +40,7 @@ In addition to cross-language serialization, Fory also
features at:
## Protocols
-Fory designed and implemented multiple binary protocols for different
scenarios:
+Apache Fory™ designed and implemented multiple binary protocols for different
scenarios:
- **[xlang serialization
format](docs/specification/xlang_serialization_spec.md)**:
- Cross-language serialize any object automatically, no need for IDL
definition, schema compilation and object to/from
@@ -51,7 +51,7 @@ Fory designed and implemented multiple binary protocols for
different scenarios:
- **[Row format format](docs/specification/row_format_spec.md)**: A
cache-friendly binary random access format, supports skipping serialization and
partial serialization, and can convert to column-format automatically.
-New protocols can be easily added based on Fory existing buffer, encoding,
meta, codegen and other capabilities. All of those share the same codebase, and
the optimization for one protocol can be reused by another protocol.
+New protocols can be easily added based on Apache Fory™ existing buffer,
encoding, meta, codegen and other capabilities. All of those share the same
codebase, and the optimization for one protocol can be reused by another
protocol.
## Benchmarks
@@ -170,7 +170,7 @@ go get github.com/apache/fory/go/fory
## Quickstart
-Here we give a quick start about how to use Fory, see [user
guide](docs/README.md) for more details about
[java](docs/guide/java_serialization_guide.md), [cross
language](docs/guide/xlang_serialization_guide.md), and [row
format](docs/guide/row_format_guide.md).
+Here we give a quick start about how to use Apache Fory™, see [user
guide](docs/README.md) for more details about
[java](docs/guide/java_serialization_guide.md), [cross
language](docs/guide/xlang_serialization_guide.md), and [row
format](docs/guide/row_format_guide.md).
### Fory java object graph serialization
@@ -387,7 +387,7 @@ print(foo_row.f2[100000], foo_row.f4[100000].f1,
foo_row.f4[200000].f2[5])
### Schema Compatibility
-Fory java object graph serialization supports class schema forward/backward
compatibility. The serialization peer and deserialization peer can add/delete
fields independently.
+Apache Fory™ java object graph serialization supports class schema
forward/backward compatibility. The serialization peer and deserialization peer
can add/delete fields independently.
We plan to add the schema compatibility support of cross-language
serialization after [meta
compression](https://github.com/apache/fory/issues/203) is finished.
diff --git a/cpp/README.md b/cpp/README.md
index 9bbd61327..04c0474d9 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -1,8 +1,8 @@
# Apache Fory™ C++
-Fory is a blazingly-fast multi-language serialization framework powered by
just-in-time compilation and zero-copy.
+Apache Fory™ is a blazingly-fast multi-language serialization framework
powered by just-in-time compilation and zero-copy.
-## Build Fory C++
+## Build Apache Fory™ C++
```bash
# Build all projects
diff --git a/dart/README.md b/dart/README.md
index 2e68b749e..72635ed2a 100644
--- a/dart/README.md
+++ b/dart/README.md
@@ -1,17 +1,17 @@
-# Fory Dart
+# Apache Fory™ Dart
## Overview
-This PR adds Dart language support to Apache Fory, implementing a
comprehensive serialization solution for Dart and Flutter applications. Fory
Dart consists of approximately 15,000 lines of code and provides an efficient
serialization mechanism that works within Flutter's reflection limitations.
+This PR adds Dart language support to Apache Fory™, implementing a
comprehensive serialization solution for Dart and Flutter applications. Apache
Fory™ Dart consists of approximately 15,000 lines of code and provides an
efficient serialization mechanism that works within Flutter's reflection
limitations.
## Implementation Approach
-Dart supports reflection, but Flutter explicitly prohibits it. To address this
constraint, Fory Dart uses a combination of:
+Dart supports reflection, but Flutter explicitly prohibits it. To address this
constraint, Apache Fory™ Dart uses a combination of:
1. Core serialization/deserialization logic
2. Static code generation for type handling
-This approach ensures compatibility with Flutter while maintaining the
performance and flexibility expected from Fory.
+This approach ensures compatibility with Flutter while maintaining the
performance and flexibility expected from Apache Fory™.
## Features
@@ -91,7 +91,7 @@ fory.register($EnumFoo, "example.EnumFoo");
## Type Support
-Fory Dart currently supports the following type mappings in XLANG mode:
+Apache Fory™ Dart currently supports the following type mappings in XLANG mode:
| Fory Type | Dart Type |
| ------------- | ------------------------------------------ |
@@ -134,16 +134,16 @@ The implementation is organized into three main
components:
Contains the core serialization and deserialization logic.
3. **ForyTest**: Located at `dart/fory-test`
- Comprehensive test suite for Fory Dart functionality.
+ Comprehensive test suite for Apache Fory™ Dart functionality.
## Testing Approach
-The test suite is inspired by Fory Java's testing approach and includes:
+The test suite is inspired by Apache Fory™ Java's testing approach and
includes:
- **Data Type Tests**: Validates custom data types implemented for Dart
- **Code Generation Tests**: Ensures correctness of the generated static code
- **Buffer Tests**: Validates correct memory handling for primitive types
-- **Cross-Language Tests**: Tests functionality against other Fory
implementations
+- **Cross-Language Tests**: Tests functionality against other Apache Fory™
implementations
- **Performance Tests**: Simple benchmarks for serialization/deserialization
performance
### Running Tests
@@ -171,7 +171,7 @@ Before executing those tests, please review and adjust the
configs in `fory-test
## Code Quality
-Fory Dart maintains high code quality standards. You can verify this using:
+Apache Fory™ Dart maintains high code quality standards. You can verify this
using:
```bash
dart analyze
diff --git a/dart/packages/fory-test/README.md
b/dart/packages/fory-test/README.md
index 3a6ef0b2c..37717f00b 100644
--- a/dart/packages/fory-test/README.md
+++ b/dart/packages/fory-test/README.md
@@ -1,11 +1,11 @@
## Testing Approach
-The test suite is inspired by Fory Java's testing approach and includes:
+The test suite is inspired by Apache Fory™ Java's testing approach and
includes:
- **Datatype Tests**: Validates custom data types implemented for Dart
- **Code Generation Tests**: Ensures correctness of the generated static code
- **Buffer Tests**: Validates correct memory handling for primitive types
-- **Cross-Language Tests**: Tests functionality against other Fory
implementations
+- **Cross-Language Tests**: Tests functionality against other Apache Fory™
implementations
- **Performance Tests**: Simple benchmarks for serialization/deserialization
performance
### Running Tests
diff --git a/dart/packages/fory/README.md b/dart/packages/fory/README.md
index bcada4994..85294638e 100644
--- a/dart/packages/fory/README.md
+++ b/dart/packages/fory/README.md
@@ -1,17 +1,17 @@
-# Fory Dart
+# Apache Fory™ Dart
## Overview
-This PR adds Dart language support to Apache Fory, implementing a
comprehensive serialization solution for Dart and Flutter applications. Fory
Dart consists of approximately 15,000 lines of code and provides an efficient
serialization mechanism that works within Flutter's reflection limitations.
+This PR adds Dart language support to Apache Fory™, implementing a
comprehensive serialization solution for Dart and Flutter applications. Apache
Fory™ Dart consists of approximately 15,000 lines of code and provides an
efficient serialization mechanism that works within Flutter's reflection
limitations.
## Implementation Approach
-Dart supports reflection, but Flutter explicitly prohibits it. To address this
constraint, Fory Dart uses a combination of:
+Dart supports reflection, but Flutter explicitly prohibits it. To address this
constraint, Apache Fory™ Dart uses a combination of:
1. Core serialization/deserialization logic
2. Static code generation for type handling
-This approach ensures compatibility with Flutter while maintaining the
performance and flexibility expected from Fory.
+This approach ensures compatibility with Flutter while maintaining the
performance and flexibility expected from Apache Fory™.
## Features
@@ -134,16 +134,16 @@ The implementation is organized into three main
components:
Contains the core serialization and deserialization logic.
3. **ForyTest**: Located at `dart/fory_test`
- Comprehensive test suite for Fory Dart functionality.
+ Comprehensive test suite for Apache Fory™ Dart functionality.
## Testing Approach
-The test suite is inspired by Fory Java's testing approach and includes:
+The test suite is inspired by Apache Fory™ Java's testing approach and
includes:
- **Datatype Tests**: Validates custom data types implemented for Dart
- **Code Generation Tests**: Ensures correctness of the generated static code
- **Buffer Tests**: Validates correct memory handling for primitive types
-- **Cross-Language Tests**: Tests functionality against other Fory
implementations
+- **Cross-Language Tests**: Tests functionality against other Apache Fory™
implementations
- **Performance Tests**: Simple benchmarks for serialization/deserialization
performance
### Running Tests
@@ -166,7 +166,7 @@ dart test
## Code Quality
-Fory Dart maintains high code quality standards. You can verify this using:
+Apache Fory™ Dart maintains high code quality standards. You can verify this
using:
```bash
dart analyze
diff --git a/docs/README.md b/docs/README.md
index 1fe31d34d..34a7b8041 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,7 +4,7 @@
- For Java Object Graph Guide, see [java serialization
guide](guide/java_serialization_guide.md) doc.
- For Row Format Guide, see [row format guide](guide/row_format_guide.md) doc.
- For Scala Guide, see [scala guide](guide/scala_guide.md) doc.
-- For using Fory with GraalVM native image, see [graalvm native image
guide](guide/graalvm_guide.md) doc.
+- For using Apache Fory™ with GraalVM native image, see [graalvm native image
guide](guide/graalvm_guide.md) doc.
## Serialization Format
diff --git a/docs/cpp_debug.md b/docs/cpp_debug.md
index c84935e9a..9fd583835 100644
--- a/docs/cpp_debug.md
+++ b/docs/cpp_debug.md
@@ -23,13 +23,13 @@ license: |
Debug C++ is tricky and binary protocol bug is hard to locate without
debugging support, but setup
debugging support for bazel project is not easy.
-Fory include an out-of-box `launch.json/tasks.json` config in `.vscode`
directory for c++ debugging.
+Apache Fory™ include an out-of-box `launch.json/tasks.json` config in
`.vscode` directory for c++ debugging.
Just open the fory root directory in vscode, then open a test file such as
`src/fory/row/row_test.cc`,
enter `F5`, then you can debug the c++ code line by line, watch variables, add
breakpoints in vscode just like
java/python debugging.
-<img src="images/vscode_debug_fory.jpg" alt="Fory Debugging Example"
width="50%" height="50%" />
+<img src="images/vscode_debug_fory.jpg" alt="Apache Fory™ Debugging Example"
width="50%" height="50%" />
## Notes
diff --git a/docs/guide/DEVELOPMENT.md b/docs/guide/DEVELOPMENT.md
index 226246371..54c0b7296 100644
--- a/docs/guide/DEVELOPMENT.md
+++ b/docs/guide/DEVELOPMENT.md
@@ -19,11 +19,11 @@ license: |
limitations under the License.
---
-## How to build Fory
+## How to build Apache Fory™
Please checkout the source tree from https://github.com/apache/fory.
-### Build Fory Java
+### Build Apache Fory™ Java
```bash
cd java
@@ -35,7 +35,7 @@ mvn clean compile -DskipTests
- java 1.8+
- maven 3.6.3+
-### Build Fory Python
+### Build Apache Fory™ Python
```bash
cd python
@@ -53,7 +53,7 @@ pip install -v -e .
- python 3.6+
-### Build Fory C++
+### Build Apache Fory™ C++
Build fory row format：
@@ -74,7 +74,7 @@ bazel build //cpp/fory/encoder:fory_encoder
- compilers with C++17 support
- bazel 6.3.2
-### Build Fory GoLang
+### Build Apache Fory™ GoLang
```bash
cd go/fory
@@ -88,7 +88,7 @@ go test -v fory_xlang_test.go
- go 1.13+
-### Build Fory Rust
+### Build Apache Fory™ Rust
```bash
cd rust
@@ -104,7 +104,7 @@ cargo test
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
-### Build Fory JavaScript
+### Build Apache Fory™ JavaScript
```bash
cd javascript
@@ -138,4 +138,4 @@ prettier --write "**/*.md"
## Contributing
-For more information, please refer to [How to contribute to
Fory](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
+For more information, please refer to [How to contribute to Apache
Fory™](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
diff --git a/docs/guide/graalvm_guide.md b/docs/guide/graalvm_guide.md
index 7a1dc7998..190614953 100644
--- a/docs/guide/graalvm_guide.md
+++ b/docs/guide/graalvm_guide.md
@@ -25,10 +25,10 @@ GraalVM `native image` can compile java code into native
code ahead to build fas
The native image doesn't have a JIT compiler to compile bytecode into machine
code, and doesn't support
reflection unless configure reflection file.
-Fory runs on GraalVM native image pretty well. Fory generates all serializer
code for `Fory JIT framework` and `MethodHandle/LambdaMetafactory` at graalvm
build time. Then use those generated code for serialization at runtime without
+Apache Fory™ runs on GraalVM native image pretty well. Apache Fory™ generates
all serializer code for `Fory JIT framework` and
`MethodHandle/LambdaMetafactory` at graalvm build time. Then use those
generated code for serialization at runtime without
any extra cost, the performance is great.
-In order to use Fory on graalvm native image, you must create Fory as an
**static** field of a class, and **register** all classes at
+In order to use Apache Fory™ on graalvm native image, you must create Fory as
an **static** field of a class, and **register** all classes at
the enclosing class initialize time. Then configure `native-image.properties`
under
`resources/META-INF/native-image/$xxx/native-image.properties` to tell graalvm
to init the class at native image
build time. For example, here we configure `org.apache.fory.graalvm.Example`
class be init at build time:
diff --git a/docs/guide/row_format_guide.md b/docs/guide/row_format_guide.md
index 4b20f1600..099f03820 100644
--- a/docs/guide/row_format_guide.md
+++ b/docs/guide/row_format_guide.md
@@ -99,7 +99,7 @@ print(f"pickle end: {datetime.datetime.now()}")
### Apache Arrow Support
-Fory Format also supports automatic conversion from/to Arrow Table/RecordBatch.
+Apache Fory™ Row Format also supports automatic conversion from/to Arrow
Table/RecordBatch.
Java:
diff --git a/docs/guide/scala_guide.md b/docs/guide/scala_guide.md
index bd84a2e88..fe3d0cdd9 100644
--- a/docs/guide/scala_guide.md
+++ b/docs/guide/scala_guide.md
@@ -19,7 +19,7 @@ license: |
limitations under the License.
---
-Fory supports all scala object serialization:
+Apache Fory™ supports all scala object serialization:
- `case` class serialization supported
- `pojo/bean` class serialization supported
@@ -31,7 +31,7 @@ Scala 2 and 3 are both supported.
## Install
-To add a dependency on Fory scala for with sbt, use the following:
+To add a dependency on Apache Fory™ scala for with sbt, use the following:
```sbt
libraryDependencies += "org.apache.fory" %% "fory-scala" % "0.12.2"
diff --git a/docs/specification/java_serialization_spec.md
b/docs/specification/java_serialization_spec.md
index 4efae2192..283bc3078 100644
--- a/docs/specification/java_serialization_spec.md
+++ b/docs/specification/java_serialization_spec.md
@@ -1,5 +1,5 @@
---
-title: Fory Java Serialization Format
+title: Java Serialization Format
sidebar_position: 1
id: fory_java_serialization_spec
license: |
@@ -21,14 +21,14 @@ license: |
## Spec overview
-Fory Java Serialization is an automatic object serialization framework that
supports reference and polymorphism. Fory
+Apache Fory™ Java Serialization is an automatic object serialization framework
that supports reference and polymorphism. Apache Fory™
will
-convert an object from/to fory java serialization binary format. Fory has two
core concepts for java serialization:
+convert an object from/to fory java serialization binary format. Apache Fory™
has two core concepts for java serialization:
-- **Fory Java Binary format**
-- **Framework to convert object to/from Fory Java Binary format**
+- **Apache Fory™ Java Binary format**
+- **Framework to convert object to/from Apache Fory™ Java Binary format**
-The serialization format is a dynamic binary format. The dynamics and
reference/polymorphism support make Fory flexible,
+The serialization format is a dynamic binary format. The dynamics and
reference/polymorphism support make Apache Fory™ flexible,
much more easy to use, but
also introduce more complexities compared to static serialization frameworks.
So the format will be more complex.
diff --git a/docs/specification/row_format_spec.md
b/docs/specification/row_format_spec.md
index abb8739f0..c83dadde6 100644
--- a/docs/specification/row_format_spec.md
+++ b/docs/specification/row_format_spec.md
@@ -1,5 +1,5 @@
---
-title: Fory Row Format
+title: Row Format
sidebar_position: 2
id: fory_row_format_spec
license: |
diff --git a/docs/specification/xlang_serialization_spec.md
b/docs/specification/xlang_serialization_spec.md
index ba0cc0067..83719872c 100644
--- a/docs/specification/xlang_serialization_spec.md
+++ b/docs/specification/xlang_serialization_spec.md
@@ -1,5 +1,5 @@
---
-title: Fory Xlang Serialization Format
+title: Xlang Serialization Format
sidebar_position: 0
id: fory_xlang_serialization_spec
license: |
@@ -25,14 +25,14 @@ license: |
>
> - Version 0.1 - serialization spec formalized
-Fory xlang serialization is an automatic object serialization framework that
supports reference and polymorphism.
-Fory will convert an object from/to fory xlang serialization binary format.
-Fory has two core concepts for xlang serialization:
+Apache Fory™ xlang serialization is an automatic object serialization
framework that supports reference and polymorphism.
+Apache Fory™ will convert an object from/to fory xlang serialization binary
format.
+Apache Fory™ has two core concepts for xlang serialization:
-- **Fory xlang binary format**
-- **Framework implemented in different languages to convert object to/from
Fory xlang binary format**
+- **Apache Fory™ xlang binary format**
+- **Framework implemented in different languages to convert object to/from
Apache Fory™ xlang binary format**
-The serialization format is a dynamic binary format. The dynamics and
reference/polymorphism support make Fory flexible,
+The serialization format is a dynamic binary format. The dynamics and
reference/polymorphism support make Apache Fory™ flexible,
much more easy to use, but
also introduce more complexities compared to static serialization frameworks.
So the format will be more complex.
diff --git a/integration_tests/cpython_benchmark/README.md
b/integration_tests/cpython_benchmark/README.md
index 061b794dd..9a7b56647 100644
--- a/integration_tests/cpython_benchmark/README.md
+++ b/integration_tests/cpython_benchmark/README.md
@@ -1,10 +1,10 @@
-# Fory CPython Benchmark
+# Apache Fory™ CPython Benchmark
-Microbenchmark for Fory serialization in cpython
+Microbenchmark for Apache Fory™ serialization in cpython
## Benchmark
-Step 1: Install Fory into Python
+Step 1: Install Apache Fory™ into Python
Step 2: Install the dependencies required for the benchmark script
diff --git a/java/benchmark/README.md b/java/benchmark/README.md
index c79feea6a..c60a30a7e 100644
--- a/java/benchmark/README.md
+++ b/java/benchmark/README.md
@@ -1,8 +1,8 @@
-# Fory Java Benchmark
+# Apache Fory™ Java Benchmark
-Fory Java Benchmark contains benchmarks for:
+Apache Fory™ Java Benchmark contains benchmarks for:
-- Fory
+- Apache Fory™
- JDK
- Hession
- Kryo
@@ -21,7 +21,7 @@ Fory Java Benchmark contains benchmarks for:
This benchmark use [jmh](https://github.com/openjdk/jmh) as benchmark tool.
[jmh](https://github.com/openjdk/jmh) is
licensed under GPL V2 with CLASSPATH exception, the usage can't be included in
apache source/binary release unless
-as an optional feature. So Fory make it as an optional dependency and you must
enable `jmh` profile to activate it.
+as an optional feature. So Apache Fory™ make it as an optional dependency and
you must enable `jmh` profile to activate it.
```bash
# Install fory
@@ -68,7 +68,7 @@ Save benchmark data to specified dir, then run `tool.py` to
plot graphs.
## Plotting
-Fory uses pandas to process the jmh data, and uses matplotlib for plotting.
+Apache Fory™ uses pandas to process the jmh data, and uses matplotlib for
plotting.
```bash
pip install pandas matplotlib
diff --git a/java/fory-core/src/main/resources/META-INF/NOTICE
b/java/fory-core/src/main/resources/META-INF/NOTICE
index fe7979ed8..d6dfd06fd 100644
--- a/java/fory-core/src/main/resources/META-INF/NOTICE
+++ b/java/fory-core/src/main/resources/META-INF/NOTICE
@@ -1,4 +1,4 @@
-Apache Fory
+Apache Fory™
Copyright 2023-2025 The Apache Software Foundation
This product includes software developed at
diff --git a/java/fory-format/src/main/resources/META-INF/NOTICE
b/java/fory-format/src/main/resources/META-INF/NOTICE
index 445dddc3e..8e36211a7 100644
--- a/java/fory-format/src/main/resources/META-INF/NOTICE
+++ b/java/fory-format/src/main/resources/META-INF/NOTICE
@@ -1,4 +1,4 @@
-Apache Fory
+Apache Fory™
Copyright 2023-2025 The Apache Software Foundation
This product includes software developed at
diff --git a/kotlin/README.md b/kotlin/README.md
index 24e6ff070..8c836e62e 100644
--- a/kotlin/README.md
+++ b/kotlin/README.md
@@ -1,12 +1,12 @@
# Apache Fory™ Kotlin
-This provides additional Fory support for Kotlin Serialization on JVM:
+This provides additional Apache Fory™ support for Kotlin Serialization on JVM:
-Most standard kotlin types are already supported out of the box with the
default Fory java implementation.
+Most standard kotlin types are already supported out of the box with the
default Apache Fory™ java implementation.
-Fory Kotlin provides additional tests and implementation support for Kotlin
types.
+Apache Fory™ Kotlin provides additional tests and implementation support for
Kotlin types.
-Fory Kotlin is tested and works with the following types:
+Apache Fory™ Kotlin is tested and works with the following types:
- primitives: `Byte`, `Boolean`, `Int`, `Short`, `Long`, `Char`, `Float`,
`Double`, `UByte`, `UShort`, `UInt`, `ULong`.
- `Byte`, `Boolean`, `Int`, `Short`, `Long`, `Char`, `Float`, `Double` works
out of the box with the default fory java implementation.
@@ -62,11 +62,11 @@ fun main(args: Array<String>) {
## Default Value Support
-Fory Kotlin provides support for Kotlin data class default values during
serialization and deserialization. This feature allows for backward and forward
compatibility when data class schemas evolve.
+Apache Fory™ Kotlin provides support for Kotlin data class default values
during serialization and deserialization. This feature allows for backward and
forward compatibility when data class schemas evolve.
### How It Works
-When a Kotlin data class has parameters with default values, Fory can:
+When a Kotlin data class has parameters with default values, Apache Fory™ can:
1. **Detect default values** using Kotlin reflection
2. **Apply default values** during deserialization when fields are missing
from serialized data
@@ -130,7 +130,7 @@ To enable default value support:
KotlinSerializers.registerSerializers(fory)
```
-## Building Fory Kotlin
+## Building Apache Fory™ Kotlin
```bash
mvn clean
diff --git a/python/CONTRIBUTING.md b/python/CONTRIBUTING.md
index fbe24c77d..baf925c05 100644
--- a/python/CONTRIBUTING.md
+++ b/python/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to Apache Fory Python
+# Contributing to Apache Fory™ Python
This document provides instructions for building and testing the `pyfory`
package.
diff --git a/python/README.md b/python/README.md
index 963c8409a..b16cb7c08 100644
--- a/python/README.md
+++ b/python/README.md
@@ -5,9 +5,9 @@
[](https://join.slack.com/t/fory-project/shared_invite/zt-36g0qouzm-kcQSvV_dtfbtBKHRwT5gsw)
[](https://x.com/ApacheFory)
-**Apache Fory** (formerly _Fury_) is a blazing fast multi-language
serialization framework powered by **JIT** (just-in-time compilation) and
**zero-copy**, providing up to 170x performance and ease of use.
+**Apache Fory™** (formerly _Fury_) is a blazing fast multi-language
serialization framework powered by **JIT** (just-in-time compilation) and
**zero-copy**, providing up to 170x performance and ease of use.
-This package provides the Python bindings for Apache Fory.
+This package provides the Python bindings for Apache Fory™.
## Installation
@@ -46,7 +46,7 @@ print(fory.deserialize(data))
### Cross-language Serialization
-Apache Fory excels at cross-language serialization. You can serialize data in
Python and deserialize it in another language like Java or Go, and vice-versa.
+Apache Fory™ excels at cross-language serialization. You can serialize data in
Python and deserialize it in another language like Java or Go, and vice-versa.
Here's an example of how to serialize an object in Python and deserialize it
in Java:
@@ -97,7 +97,7 @@ public class ReferenceExample {
### Row Format Zero-Copy Partial Serialzation
-Apache Fory provide a random-access row format, which supports map a typed
nested struct into a binary and read its nested element without deserializing
the whole binary. This can be used to minimize teh deserialization overhead for
huge objects in the case where you only needs to access part of the data. You
can even encode huge objects into binary and write to file, then mmap that file
into memory to reduce memory overhead too.
+Apache Fory™ provide a random-access row format, which supports map a typed
nested struct into a binary and read its nested element without deserializing
the whole binary. This can be used to minimize teh deserialization overhead for
huge objects in the case where you only needs to access part of the data. You
can even encode huge objects into binary and write to file, then mmap that file
into memory to reduce memory overhead too.
**Python**
diff --git a/rust/README.md b/rust/README.md
index 789dacce3..ca30cc02e 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -4,7 +4,7 @@
[](https://docs.rs/fory)
[](LICENSE)
-Fory is a blazingly fast multi-language serialization framework powered by
+Apache Fory™ is a blazingly fast multi-language serialization framework
powered by
codegen and zero-copy techniques. It provides high-performance
serialization and deserialization for Rust applications with cross-language
compatibility.
@@ -28,7 +28,7 @@ This repository contains three main crates:
## 🏃♂️ Quick Start
-Add Fory to your `Cargo.toml`:
+Add Apache Fory™ to your `Cargo.toml`:
```toml
[dependencies]
@@ -193,7 +193,7 @@ assert_eq!(prefs.values().get(0), "en");
## ⚡ Performance
-Fory is designed for maximum performance:
+Apache Fory™ is designed for maximum performance:
- **Zero-copy deserialization** in row mode
- **Buffer pre-allocation** to minimize allocations
@@ -203,7 +203,7 @@ Fory is designed for maximum performance:
## 🌍 Cross-Language Compatibility
-Fory is designed to work across multiple programming languages, making it
ideal for:
+Apache Fory™ is designed to work across multiple programming languages, making
it ideal for:
- **Microservices architectures** with polyglot services
- **Distributed systems** with heterogeneous components
@@ -218,7 +218,7 @@ cargo bench --package fory-benchmarks
## 🛠️ Development Status
-Fory Rust implementation roadmap:
+Apache Fory™ Rust implementation roadmap:
- [x] Static codegen based on rust macro
- [x] Row format serialization
diff --git a/scala/README.md b/scala/README.md
index 0ed1b6561..bbf04b584 100644
--- a/scala/README.md
+++ b/scala/README.md
@@ -1,6 +1,6 @@
# Apache Fory™ Scala
-Fory supports all scala object serialization:
+Apache Fory™ supports all scala object serialization:
- `case` class serialization supported
- `pojo/bean` class serialization supported
diff --git a/scala/build.sbt b/scala/build.sbt
index b76c3ba67..7a9ca006b 100644
--- a/scala/build.sbt
+++ b/scala/build.sbt
@@ -28,13 +28,13 @@ lazy val root = Project(id = "fory-scala", base = file("."))
name := "fory-scala",
apacheSonatypeLicenseFile := baseDirectory.value / ".." / "LICENSE",
apacheSonatypeNoticeFile := baseDirectory.value / ".." / "NOTICE",
- description := "Apache Fory is a blazingly fast multi-language
serialization framework powered by JIT and zero-copy.",
+ description := "Apache Fory™ is a blazingly fast multi-language
serialization framework powered by JIT and zero-copy.",
homepage := Some(url("https://fory.apache.org/";)),
startYear := Some(2024),
developers := List(
Developer(
"fory-contributors",
- "Apache Fory Contributors",
+ "Apache Fory™ Contributors",
"[email protected]",
url("https://github.com/apache/fory/graphs/contributors";))))
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
