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.

addCopyFileToSource

Overwrites a path relative to the build root with the contents of another file.

Because it updates source files, this should not be used as part of the normal build process, but as a utility occasionally run by a developer with intent to modify source files and then commit those changes to version control.

UpdateSourceFiles.addCopyFileToSource

pub fn addCopyFileToSource(usf: *UpdateSourceFiles, src_file: std.Build.LazyPath, sub_path: []const u8) void

File

lib/std/Build/Step/UpdateSourceFiles.zig:35

Code

pub fn addCopyFileToSource(usf: *UpdateSourceFiles, src_file: std.Build.LazyPath, sub_path: []const u8) void {
    const graph = usf.step.owner.graph;
    const wc = &graph.wip_configuration;
    const arena = graph.arena;

    usf.copies.append(arena, .{
        .sub_path = wc.addString(sub_path) catch @panic("OOM"),
        .src_file = src_file.dupe(graph),
    }) catch @panic("OOM");

    src_file.addStepDependencies(&usf.step);
}