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.

addMutateFiles

Creates a step for mutating temporary directories created with addTempFiles.

Consider instead addWriteFiles which is for creating a cached directory of files to operate on.

This should only be used with a tmp_path obtained via addTempFiles or tmpPath.

Build.addMutateFiles

pub fn addMutateFiles(b: *Build, tmp_path: LazyPath) *Step.WriteFile

File

lib/std/Build.zig:1070

Code

pub fn addMutateFiles(b: *Build, tmp_path: LazyPath) *Step.WriteFile {
    const wf = addWriteFiles(b);
    wf.mode = .{ .mutate = tmp_path };
    tmp_path.addStepDependencies(&wf.step);
    return wf;
}