Skip to content

Update protobuf version in doc #2618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wwbmmm merged 1 commit into from
Apr 29, 2024
Merged

Update protobuf version in doc #2618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/cn/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,11 +341,9 @@ GCC7中over-aligned的问题暂时被禁止。

无已知问题。

## protobuf: 2.4+
## protobuf: 3.0-3.25

同一个文件兼容pb 3.x版本和pb 2.x版本：
不要使用proto3新增的类型，并且在proto文件的起始位置添加`syntax=proto2;`声明。
[tools/add_syntax_equal_proto2_to_all.sh](https://github.com/apache/brpc/blob/master/tools/add_syntax_equal_proto2_to_all.sh)这个脚本可以给所有没有这行声明的proto文件添加`syntax="proto2"`声明。
[1.8.0版本](https://github.com/apache/brpc/releases/tag/1.8.0)中[#2406](https://github.com/apache/brpc/pull/2406)和[#2493](https://github.com/apache/brpc/pull/2493)引入了部分proto3语法，所以目前bRPC不再兼容pb 2.x版本。如果你希望使用pb 2.x版本，可以使用1.8.0之前的bRPC版本。

pb 3.x中的Arena至今没被支持。

Expand Down
6 changes: 2 additions & 4 deletions docs/en/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,9 @@ no known issues.

no known issues.

## protobuf: 2.4+
## protobuf: 3.0-3.25

Be compatible with pb 3.x and pb 2.x with the same file:
Don't use new types in proto3 and start the proto file with `syntax="proto2";`
[tools/add_syntax_equal_proto2_to_all.sh](https://github.com/apache/brpc/blob/master/tools/add_syntax_equal_proto2_to_all.sh)can add `syntax="proto2"` to all proto files without it.
[#2406](https://github.com/apache/brpc/pull/2406) and [#2493](https://github.com/apache/brpc/pull/2493) in [version 1.8.0]((https://github.com/apache/brpc/releases/tag/1.8.0)) introduce some proto3 syntax, so currently bRPC is no longer compatible with pb 2.x version. If you want to use pb 2.x version, you can use bRPC version before 1.8.0.

Arena in pb 3.x is not supported yet.

Expand Down