Skip to content

Update the README with the changes that were made to LMDB #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Update the README with the changes that were made to LMDB #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This wrapper provides exposure of the library's C interfaces to Swift, allowing

Changes in LMDB will be pulled into this repository as the upstream project evolves. The LMDB repository is mirrored here: <https://github.com/LMDB/lmdb>.

## Changes to LMDB

Swift LMDB makes two local changes to LMDB in order to pass thread sanitization checks in [IndexStoreDB](https://github.com/swiftlang/indexstore-db). These changes are:
- Use `_Atomic` instead of `volatile` for transaction types
- Build with POSIX mutexes enabled and robust mutexes disabled on Linux and macOS

## License

The included LMDB database project is released under [The OpenLDAP Public License](https://git.openldap.org/openldap/openldap/-/blob/mdb.master/libraries/liblmdb/LICENSE). This same license applies to the Swift code included in this repository.