You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fury.apache.org by tw...@apache.org on 2024/01/05 06:49:12 UTC
(incubator-fury) branch PragmaTwice-patch-1 created (now d4848bbc)
This is an automated email from the ASF dual-hosted git repository.
twice pushed a change to branch PragmaTwice-patch-1
in repository https://gitbox.apache.org/repos/asf/incubator-fury.git
at d4848bbc Refine words and remove other org links in README
This branch includes the following new commits:
new d4848bbc Refine words and remove other org links in README
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fury.apache.org
For additional commands, e-mail: commits-help@fury.apache.org
(incubator-fury) 01/01: Refine words and remove other org links in README
Posted by tw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
twice pushed a commit to branch PragmaTwice-patch-1
in repository https://gitbox.apache.org/repos/asf/incubator-fury.git
commit d4848bbc191f565508a03a17d0987553d8a612c4
Author: Twice <tw...@apache.org>
AuthorDate: Fri Jan 5 14:49:09 2024 +0800
Refine words and remove other org links in README
---
README.md | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 8bc117af..7075dcb5 100644
--- a/README.md
+++ b/README.md
@@ -46,7 +46,7 @@ multiple binary protocols for those requirements:
- **Row format protocol**: 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 fury existing buffer, encoding, meta, codegen and other capabilities. All of those share the same codebase, and the optimization for one protocol
+New protocols can be easily added based on Fury 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
@@ -148,7 +148,7 @@ go get github.com/apache/incubator-fury/go/fury
```
## Quickstart
-Here we give a quick start about how to use fury, see [user guide](https://github.com/apache/incubator-fury/blob/main/docs/README.md) for more details about [java](https://github.com/apache/incubator-fury/blob/main/docs/guide/java_object_graph_guide.md), [cross language](https://github.com/apache/incubator-fury/blob/main/docs/guide/xlang_object_graph_guide.md), and [row format](https://github.com/apache/incubator-fury/blob/main/docs/guide/row_format_guide.md).
+Here we give a quick start about how to use Fury, see [user guide](https://github.com/apache/incubator-fury/blob/main/docs/README.md) for more details about [java](https://github.com/apache/incubator-fury/blob/main/docs/guide/java_object_graph_guide.md), [cross language](https://github.com/apache/incubator-fury/blob/main/docs/guide/xlang_object_graph_guide.md), and [row format](https://github.com/apache/incubator-fury/blob/main/docs/guide/row_format_guide.md).
### Fury java object graph serialization
If you don't have cross-language requirements, using this mode will
@@ -355,20 +355,21 @@ print(foo_row.f2[100000], foo_row.f4[100000].f1, foo_row.f4[200000].f2[5])
```
## Compatibility
+
### Schema Compatibility
-Fury java object graph serialization support class schema forward/backward compatibility. The serialization peer and deserialization peer can add/delete fields independently.
+Fury 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 support cross-language serialization after [meta compression](https://github.com/apache/incubator-fury/issues/203) is finished.
+We plan to add the schema compatibility support of cross-language serialization after [meta compression](https://github.com/apache/incubator-fury/issues/203) is finished.
### Binary Compatibility
-We are still improving our protocols, binary compatibility is not ensured between fury major releases for now.
-it's ensured between minor versions only. Please
-`versioning` your data by fury major version if you will upgrade fury in the future, see [how to upgrade fury](https://github.com/apache/incubator-fury/blob/main/docs/guide/java_object_graph_guide.md#upgrade-fury) for further details.
+We are still improving our protocols, thus binary compatibility is not guaranteed between Fury major releases for now.
+However, it is guaranteed between minor versions. Please
+`versioning` your data by Fury major version if you will upgrade Fury in the future, see [how to upgrade fury](https://github.com/apache/incubator-fury/blob/main/docs/guide/java_object_graph_guide.md#upgrade-fury) for further details.
-Binary compatibility will be ensured when fury 1.0 is released.
+Binary compatibility will be guaranteed when Fury 1.0 is released.
## Security
-Static serialization is secure. But dynamic serialization such as fury java/python native serialization supports deserializing unregistered types, which provides more dynamics and flexibility, but also introduce security risks.
+Static serialization is relatively secure. But dynamic serialization such as Fury java/python native serialization supports deserializing unregistered types, which provides more dynamics and flexibility, but also introduce security risks.
For example, the deserialization may invoke `init` constructor or `equals`/`hashCode` method, if the method body contains malicious code, the system will be at risk.
@@ -378,6 +379,8 @@ Fury provides a class registration option that is enabled by default for such pr
If this option is disabled, you are responsible for serialization security. You can configure `org.apache.fury.resolver.ClassChecker` by
`ClassResolver#setClassChecker` to control which classes are allowed for serialization.
+To report security vulnerabilities found in Fury, please follow the [ASF vulnerability reporting process](https://apache.org/security/#reporting-a-vulnerability).
+
## How to Build
Please read the [BUILD](docs/guide/DEVELOPMENT.md) guide for instructions on how to build.
@@ -386,8 +389,6 @@ Please read the [BUILD](docs/guide/DEVELOPMENT.md) guide for instructions on how
Please read the [CONTRIBUTING](CONTRIBUTING.md) guide for instructions on how to contribute.
-For ecosystem projects, please see https://github.com/fury-project
-
## License
Licensed under the [Apache License, Version 2.0](LICENSE)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fury.apache.org
For additional commands, e-mail: commits-help@fury.apache.org