diff --git a/README.md b/README.md index 01fe6fd6..d2620971 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,13 @@ In order to build this project from source code you need to have: 1. Visual Studio 2019 (i.e. Community Edition, version 16.2.5) with "C/C++ features" enabled, 1. Windows SDK 10, 1. [Git Bash](https://gitforwindows.org/) for Windows or [Cygwin](http://cygwin.com/) with Git - after cloning this repository you need to run `src/mkreleasehdr.sh` script that creates `src/release.h` with some information taken from Git; optionally you can create that file by hand. + +**Dependencies** + +This project depends on [`jemalloc`](https://github.com/jemalloc/jemalloc) memory allocator, which is slightly customized +in regard to calls to `VirtualAlloc` and `VirtualFree` WinAPI functions. They are being replaced with calls to `AllocHeapBlock/PurgePages` +and `FreeHeapBlock` from `src/Win32_Interop/Win32_QFork.cpp` in order to keep track which memory regions are to be made +available to child processes (for saving RDB/AOF). + +Changes to `jemalloc` that provide those customizations are being maintained in [tporadowski/jemalloc repository](https://github.com/tporadowski/jemalloc) +and are copied over to `deps/jemalloc`. \ No newline at end of file