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.

create

InstallFile.create

pub fn create(
    owner: *std.Build,
    source: LazyPath,
    dir: InstallDir,
    dest_rel_path: []const u8,
) *InstallFile

File

lib/std/Build/Step/InstallFile.zig:16

Code

pub fn create(
    owner: *std.Build,
    source: LazyPath,
    dir: InstallDir,
    dest_rel_path: []const u8,
) *InstallFile {
    assert(dest_rel_path.len != 0);
    const graph = owner.graph;
    const arena = graph.arena;
    const install_file = arena.create(InstallFile) catch @panic("OOM");
    install_file.* = .{
        .step = Step.init(.{
            .tag = base_tag,
            .name = owner.fmt("install {f} to {s}", .{ source, dest_rel_path }),
            .owner = owner,
        }),
        .source = source.dupe(graph),
        .dir = dir.dupe(graph),
        .dest_rel_path = graph.dupePath(dest_rel_path),
    };
    source.addStepDependencies(&install_file.step);
    return install_file;
}