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.

addUpdateSourceFiles

Creates a step for writing data to paths relative to the build root, mutating the project's source files.

This build step was designed not to be used during the normal build process, but rather as a utility run by a developer with intention to update source files, which will then be committed to version control.

Example use cases:

precompiling assets which are tracked by version control
snapshot testing

Build.addUpdateSourceFiles

pub fn addUpdateSourceFiles(b: *Build) *Step.UpdateSourceFiles

File

lib/std/Build.zig:1091

Code

pub fn addUpdateSourceFiles(b: *Build) *Step.UpdateSourceFiles {
    return Step.UpdateSourceFiles.create(b);
}