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/fury.git
The following commit(s) were added to refs/heads/main by this push:
new 26dad611 chore: Delete the redundant comments and add the document
(#2244)
26dad611 is described below
commit 26dad61181755494249fa9e1351ad5c6271afc26
Author: PAN <[email protected]>
AuthorDate: Mon May 19 14:40:23 2025 +0800
chore: Delete the redundant comments and add the document (#2244)
<!--
**Thanks for contributing to Fury.**
**If this is your first time opening a PR on fury, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fury/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fury (incubating)** community has restrictions on the
naming of pr titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fury/blob/main/CONTRIBUTING.md).
- Fury 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.
-->
## What does this PR do?
Delete the redundant comments and add the document.
<!-- Describe the purpose of this PR. -->
## Related issues
<!--
Is there any related issue? Please attach here.
- #xxxx0
- #xxxx1
- #xxxx2
-->
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fury/issues/new/choose) describing the
need to do so and update the document if necessary.
-->
- [ ] 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.
-->
---
go/README.md | 19 +++++++++++++++++++
go/fury/buffer.go | 2 +-
2 files changed, 20 insertions(+), 1 deletion(-)
diff --git a/go/README.md b/go/README.md
index 2767a00d..6bb83006 100644
--- a/go/README.md
+++ b/go/README.md
@@ -5,3 +5,22 @@ Fury is a blazingly fast multi-language serialization
framework powered by just-
Currently, Fury Go is implemented using reflection. In the future, we plan to
implement a static code generator
to generate serializer code ahead to speed up serialization, or implement a
JIT framework which generate ASM
instructions to speed up serialization.
+
+## How to test
+
+```bash
+cd go/fury
+go test -v
+go test -v fury_xlang_test.go
+```
+
+## Code Style
+
+```bash
+cd go/fury
+gofmt -s -w .
+```
+
+When using Go's gofmt -s -w . command on Windows, ensure your source files use
Unix-style line endings (LF) instead of Windows-style (CRLF). Go tools expect
LF by default, and mismatched line endings may cause unexpected behavior or
unnecessary changes in version control.
+
+Before committing, you can use `git config core.autocrlf input` to take effect
on future commits.
diff --git a/go/fury/buffer.go b/go/fury/buffer.go
index d47dcf79..5b7d2b61 100644
--- a/go/fury/buffer.go
+++ b/go/fury/buffer.go
@@ -558,7 +558,7 @@ func (b *ByteBuffer) readVarUint32Slow() uint32 {
break
}
shift += 7
- if shift >= 28 { // 32位最多需要5字节（28位）
+ if shift >= 28 {
panic("varuint32 overflow")
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
