From 136570b962d1f2092409963312e3ddbb7457f91b Mon Sep 17 00:00:00 2001 From: Matthew Bastien Date: Tue, 17 Dec 2024 13:45:03 -0500 Subject: [PATCH] update README to indicate the changes that were made to LMDB in this repository --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 7ca32f4688..3f880857f6 100644 --- a/README.md +++ b/README.md @@ -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: . +## 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.