docs: add detailed section on sync module and its integration with loom#13
Merged
Conversation
daa113c to
68a169e
Compare
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.
This pull request adds documentation to clarify the purpose and usage of concurrency testing tools and the custom
syncmodule in the project. The most important changes include new explanations and links forloomandMiriin the mainREADME.md, and a detailed guide for thesyncmodule in its own README.Concurrency testing tools documentation:
loomlibrary inREADME.md, explaining its role in testing parallel and concurrent programs.Miriinterpreter inREADME.md, outlining its ability to detect undefined behavior in Rust code.syncmodule documentation:src/sync/README.mdfile explaining the motivation, design, and usage of thesyncabstraction layer for compatibility withloom, including how it enables deterministic concurrency testing and how to use it in the project.