Add comment warning against using page_allocator with GeneralPurposeA…

…llocator page_allocator + GeneralPurposeAllocator is a performance footgun zigtools/zls#1128
Jarred-Sumner · Apr 18, 2023 · fa0b866 · fa0b866
1 parent 40e1fca
commit fa0b866
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/std/heap.zig b/lib/std/heap.zig
@@ -222,6 +222,8 @@ fn rawCFree(
 
 /// This allocator makes a syscall directly for every allocation and free.
 /// Thread-safe and lock-free.
+///
+/// Using `page_allocator` with `GeneralPurposeAllocator` outside of WebAssembly is not recommended, as it causes detrimental performance issues in long-running programs.
 pub const page_allocator = if (builtin.target.isWasm())
     Allocator{
         .ptr = undefined,