Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

page_size_min

comptime-known minimum page size of the target.

All pointers from mmap or NtAllocateVirtualMemory are aligned to at least page_size_min, but their actual alignment may be bigger.

This value can be overridden via std.options.page_size_min.

On many systems, the actual page size can only be determined at runtime with pageSize.

heap.page_size_min

pub const page_size_min: usize = std.options.page_size_min orelse (page_size_min_default orelse @compileError(@tagName(builtin.cpu.arch) ++ "-" ++ @tagName(builtin.os.tag) ++ " has unknown page_size_min; populate std.options.page_size_min"))

File

lib/std/heap.zig:46

Code

pub const page_size_min: usize = std.options.page_size_min orelse (page_size_min_default orelse @compileError(@tagName(builtin.cpu.arch) ++ "-" ++ @tagName(builtin.os.tag) ++ " has unknown page_size_min; populate std.options.page_size_min"))