Document single Go runtime limitation - #144
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates libXray’s integration documentation for Apple targets to explicitly warn that only one Go runtime can be loaded per process, based on the crash scenario described in #116, and keeps the English and Chinese READMEs aligned.
Changes:
- Add an explicit “one Go runtime per process” warning for iOS/macOS integrations (cgo + gomobile).
- Clarify that independently built Go/gomobile frameworks cannot be safely merged/repackaged to avoid the limitation.
- Update the “use gomobile” guidance to remain compatible with the new warning in both READMEs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds Apple integration warning and clarifies single-Go-runtime-per-process requirements. |
| readme/README.zh_CN.md | Mirrors the same Apple warning and guidance in Chinese to keep docs synchronized. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Why
Issue #116 exposed the restriction through an early iOS Network Extension crash, but the underlying Go runtime constraint is process-wide and platform-independent. Go does not support multiple independently built runtimes in one process, and failures may occur during build, link, load, or runtime initialization before application code runs.
The documentation now applies the rule to every native libXray artifact while making clear that separate OS processes may each load one Go runtime.
Validation
git diff --checkRefs #116