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.

dependOnFileMetadata

Indicates that the build.zig logic depends on a particular file's size, inode, mtime, and contents.

If the file is created, deleted, has its contents changed, or the inode changes, or the mtime changes, the configure phase will be repeated.

This is an alternative to Graph.poisonCache that avoids making every invocation of zig build into a cache miss.

Only a subset of LazyPath are supported:

Relative to cwd
Relative to any package root
Relative to zig cache or zig installation

If the file would be inside one of the search prefixes, then the dependency cannot be tracked; Graph.poisonCache must be used instead.

Build.dependOnFileMetadata

pub fn dependOnFileMetadata(b: *Build, lazy_path: LazyPath) void

File

lib/std/Build.zig:2831

Code

pub fn dependOnFileMetadata(b: *Build, lazy_path: LazyPath) void {
    validateConfigureDependency(lazy_path);
    const graph = b.graph;
    graph.configure_dependencies.append(graph.arena, .{
        .lazy_path = lazy_path.dupe(graph),
        .mode = .metadata,
    }) catch @panic("OOM");
}