aboutsummaryrefslogtreecommitdiff
path: root/doc/langref.html.in
diff options
context:
space:
mode:
authorAndrew Kelley <andrew@ziglang.org>2020-08-08 02:15:34 -0700
committerAndrew Kelley <andrew@ziglang.org>2020-08-08 02:15:34 -0700
commit72b5ceed66005f03933a4e5bbd0eda08378b0fd0 (patch)
treea7601d5ffb62d290e83e9fcd109d47073e38a00e /doc/langref.html.in
parent88ac0c128755b076cf357a9289e9ee847bf2794a (diff)
downloadzig-72b5ceed66005f03933a4e5bbd0eda08378b0fd0.tar.gz
zig-72b5ceed66005f03933a4e5bbd0eda08378b0fd0.zip
update langref in light of new general purpose allocator
Diffstat (limited to 'doc/langref.html.in')
-rw-r--r--doc/langref.html.in14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/langref.html.in b/doc/langref.html.in
index 941c2cc1a6..dbdeb0fb42 100644
--- a/doc/langref.html.in
+++ b/doc/langref.html.in
@@ -9357,9 +9357,17 @@ pub fn main() !void {
is handled correctly? In this case, use {#syntax#}std.testing.FailingAllocator{#endsyntax#}.
</li>
<li>
- Finally, if none of the above apply, you need a general purpose allocator. Zig does not
- yet have a general purpose allocator in the standard library,
- <a href="https://github.com/andrewrk/zig-general-purpose-allocator/">but one is being actively developed</a>.
+ Are you writing a test? In this case, use {#syntax#}std.testing.allocator{#endsyntax#}.
+ </li>
+ <li>
+ Finally, if none of the above apply, you need a general purpose allocator.
+ Zig's general purpose allocator is available as a function that takes a {#link|comptime#}
+ {#link|struct#} of configuration options and returns a type.
+ Generally, you will set up one {#syntax#}std.heap.GeneralPurposeAllocator#{endsyntax#} in
+ your main function, and then pass it or sub-allocators around to various parts of your
+ application.
+ </li>
+ <li>
You can also consider {#link|Implementing an Allocator#}.
</li>
</ol>