Add architecture, code map and glossary - #74
Merged
Merged
Conversation
A map of the code: processes and threads, the life of a call in each context mode, the paths Python uses to call Erlang, which code is live and which is legacy, and one meaning per overloaded word (worker, context, pool). The stale file list in the NIF headers now points at these pages. Also completes the 4.2.0 changelog.
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
1 participant
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.
Documentation that says how the pieces fit before anyone opens
c_src/orpy_context.erl.The architecture page gives the process and thread model, the life of a call in worker, owngil and isolated mode with the functions on the path, the four delivery paths of
erlang.call, the three asyncio machineries and why they differ, where state lives, and the invariants to keep. The code map lists every Erlang, C and Python file with what it owns, whether it is live or legacy, and which guide and suites cover it; the C and Python packages get a README each. The glossary fixes one meaning per overloaded word: "worker" alone has seven uses in the tree.The stale
@mainpageinpy_nif.h, which listed four of the fourteen C files and execution modes that no longer exist, now points at these pages. Nothing in the code changes. Next steps, one PR each: remove the legacy paths the map names, lock and ownership contracts on the structs, protocol and state-machine pages, a contributing guide with recipes, and decision records.