docs: update README files and GoDocs#12
Merged
Merged
Conversation
Signed-off-by: Robin He <git@hybscloud.com>
There was a problem hiding this comment.
Pull request overview
This PR updates package-level GoDocs and multilingual README documentation to better describe uring as a Linux 6.18+-baseline, kernel-boundary (non-scheduler) io_uring API, and to expand/refresh the usage examples accordingly.
Changes:
- Refreshes the ring lifecycle examples to use
iox.Classify/iox.Backofffor “no progress” conditions. - Adds/expands documentation around buffer provisioning paths (registered fixed buffers, provided buffers, and bundle receives via
BundleIterator). - Clarifies the “no fallback for older kernels” stance across README translations and Go package docs.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| doc.go | Updates package GoDoc narrative and examples (ring lifecycle, buffer groups, bundle receives). |
| README.md | Updates English README overview and examples; expands buffer provisioning section. |
| README.zh-CN.md | Updates Simplified Chinese README with the same conceptual and example refresh. |
| README.ja.md | Updates Japanese README with the same conceptual and example refresh. |
| README.fr.md | Updates French README with the same conceptual and example refresh. |
| README.es.md | Updates Spanish README with the same conceptual and example refresh. |
Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary