Skip to content

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

Merged
Matthew Parkinson (mjp41) merged 1 commit into
microsoft:mainfrom
lenamonj:docs-header-only-recipe
Sep 7, 2026
Merged

Fix the header-only integration recipe in BUILDING.md#878
Matthew Parkinson (mjp41) merged 1 commit into
microsoft:mainfrom
lenamonj:docs-header-only-recipe

Conversation

@lenamonj

Copy link
Copy Markdown
Contributor

The header-only section of docs/BUILDING.md links snmalloc_lib, a target that left CMakeLists.txt in the CMake cleanup (#384), and includes src/snmalloc/override/malloc.cc, a path that resolves neither relative to the caller's file nor on any include path. A project following the recipe verbatim does not build.

This links the snmalloc interface target instead, which puts src on the include path, and includes the two override files through that path.

Verified on a fresh clone of main by extracting the fenced blocks of the section into a consumer project with [lib_name] replaced by a target name: before the change the build fails at the first include, after it the binary builds, defines malloc_good_size and exits 0. Documentation only.

@mjp41 Matthew Parkinson (mjp41) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing.

@mjp41
Matthew Parkinson (mjp41) merged commit fcc78fc into microsoft:main Sep 7, 2026
197 checks passed
@lenamonj
Jeff Lenamon (lenamonj) deleted the docs-header-only-recipe branch September 7, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants