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.

addTempFiles

Creates a step for mutating files inside a temporary directory created lazily and automatically cleaned up upon successful build.

The directory will be placed inside "tmp" rather than "o", and caching will be skipped. During the make phase, the step will always do all the file system operations, and on successful build completion, the dir will be deleted along with all other tmp directories. The directory is therefore eligible to be used for mutations by other steps.

File

lib/std/Build.zig:1057

Code

pub fn addTempFiles(b: *Build) *Step.WriteFile {
    const wf = addWriteFiles(b);
    wf.mode = .tmp;
    return wf;
}