Skip to content

Fix the header-only integration recipe in BUILDING.md #878

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
Matthew Parkinson (mjp41) merged 1 commit into from
Sep 7, 2026
Merged

Fix the header-only integration recipe in BUILDING.md #878

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
8 changes: 4 additions & 4 deletions docs/BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,17 @@ set(SNMALLOC_HEADER_ONLY_LIBRARY ON)
add_subdirectory(snmalloc EXCLUDE_FROM_ALL)
```

In addition make sure your executable is compiled to support 128 bit atomic operations. This may require you to add the following to your CMake file.
Then link your target against the `snmalloc` interface target. This puts snmalloc's headers on the include path and adds the compiler flags it needs, including support for 128 bit atomic operations.

```cmake
target_link_libraries([lib_name] PRIVATE snmalloc_lib)
target_link_libraries([lib_name] PRIVATE snmalloc)
```

You will also need to compile the relevant parts of snmalloc itself. Create a new file with the following contents and compile it with the rest of your application.

```c++
#include "src/snmalloc/override/malloc.cc"
#include "src/snmalloc/override/new.cc"
#include "snmalloc/override/malloc.cc"
#include "snmalloc/override/new.cc"
```

To enable the `reallocarray` symbol export, this can be added to your cmake command line.
Expand Down
Loading