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 standard library.
std › c › MADV Public Constant MADV Doc Source Public Constant std.c.MADV
pub const MADV = switch (native_os ) File c.zig: 1543
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631 pub const MADV = switch (native_os ) {
.linux => linux .MADV ,
.emscripten => emscripten .MADV ,
.driverkit , .ios , .maccatalyst , .macos , .tvos , .visionos , .watchos => struct {
pub const NORMAL = 0 ;
pub const RANDOM = 1 ;
pub const SEQUENTIAL = 2 ;
pub const WILLNEED = 3 ;
pub const DONTNEED = 4 ;
pub const FREE = 5 ;
pub const ZERO_WIRED_PAGES = 6 ;
pub const FREE_REUSABLE = 7 ;
pub const FREE_REUSE = 8 ;
pub const CAN_REUSE = 9 ;
pub const PAGEOUT = 10 ;
pub const ZERO = 11 ;
},
.freebsd => struct {
pub const NORMAL = 0 ;
pub const RANDOM = 1 ;
pub const SEQUENTIAL = 2 ;
pub const WILLNEED = 3 ;
pub const DONTNEED = 4 ;
pub const FREE = 5 ;
pub const NOSYNC = 6 ;
pub const AUTOSYNC = 7 ;
pub const NOCORE = 8 ;
pub const CORE = 9 ;
pub const PROTECT = 10 ;
},
.illumos => struct {
/// no further special treatment
pub const NORMAL = 0 ;
/// expect random page references
pub const RANDOM = 1 ;
/// expect sequential page references
pub const SEQUENTIAL = 2 ;
/// will need these pages
pub const WILLNEED = 3 ;
/// don't need these pages
pub const DONTNEED = 4 ;
/// contents can be freed
pub const FREE = 5 ;
/// default access
pub const ACCESS_DEFAULT = 6 ;
/// next LWP to access heavily
pub const ACCESS_LWP = 7 ;
/// many processes to access heavily
pub const ACCESS_MANY = 8 ;
/// contents will be purged
pub const PURGE = 9 ;
},
.dragonfly => struct {
pub const SEQUENTIAL = 2 ;
pub const CONTROL_END = SETMAP ;
pub const DONTNEED = 4 ;
pub const RANDOM = 1 ;
pub const WILLNEED = 3 ;
pub const NORMAL = 0 ;
pub const CONTROL_START = INVAL ;
pub const FREE = 5 ;
pub const NOSYNC = 6 ;
pub const AUTOSYNC = 7 ;
pub const NOCORE = 8 ;
pub const CORE = 9 ;
pub const INVAL = 10 ;
pub const SETMAP = 11 ;
},
// https://github.com/SerenityOS/serenity/blob/6d59d4d3d9e76e39112842ec487840828f1c9bfe/Kernel/API/POSIX/sys/mman.h#L35-L41
.serenity => struct {
pub const NORMAL = 0x0 ;
pub const SET_VOLATILE = 0x1 ;
pub const SET_NONVOLATILE = 0x2 ;
pub const DONTNEED = 0x3 ;
pub const WILLNEED = 0x4 ;
pub const SEQUENTIAL = 0x5 ;
pub const RANDOM = 0x6 ;
},
.netbsd , .openbsd => struct {
pub const NORMAL = 0 ;
pub const RANDOM = 1 ;
pub const SEQUENTIAL = 2 ;
pub const WILLNEED = 3 ;
pub const DONTNEED = 4 ;
pub const SPACEAVAIL = 5 ;
pub const FREE = 6 ;
},
else => void ,
}