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

InstallArtifact.create
pub fn create(owner: *std.Build, artifact: *Step.Compile, options: Options) *InstallArtifact

File

lib/std/Build/Step/InstallArtifact.zig:55

Code

pub fn create(owner: *std.Build, artifact: *Step.Compile, options: Options) *InstallArtifact {
    const install_artifact = owner.allocator.create(InstallArtifact) catch @panic("OOM");
    const dest_dir: ?InstallDir = switch (options.dest_dir) {
        .disabled => null,
        .default => switch (artifact.kind) {
            .obj, .test_obj => @panic("object files have no standard installation procedure"),
            .exe, .@"test" => .bin,
            .lib => if (artifact.isDll()) .bin else .lib,
        },
        .override => |o| o,
    };
    const pdb_dir: ?InstallDir = switch (options.pdb_dir) {
        .disabled => null,
        .default => if (artifact.producesPdbFile()) dest_dir else null,
        .override => |o| o,
    };
    const implib_dir: ?InstallDir = switch (options.implib_dir) {
        .disabled => null,
        .default => if (artifact.producesImplib()) .lib else null,
        .override => |o| o,
    };
    install_artifact.* = .{
        .step = Step.init(.{
            .tag = base_tag,
            .name = owner.fmt("install {s}", .{artifact.name}),
            .owner = owner,
        }),
        .dest_dir = dest_dir,
        .pdb_dir = pdb_dir,
        .h_dir = switch (options.h_dir) {
            .disabled => null,
            .default => if (artifact.kind == .lib) .header else null,
            .override => |o| o,
        },
        .implib_dir = implib_dir,

        .dylib_symlinks = options.dylib_symlinks orelse (dest_dir != null and
            artifact.isDynamicLibrary() and artifact.version != null and
            std.Build.wantSharedLibSymLinks(artifact.rootModuleTarget())),

        .dest_sub_path = options.dest_sub_path,

        .emitted_bin = if (dest_dir != null) artifact.getEmittedBin() else null,
        .emitted_pdb = if (pdb_dir != null) artifact.getEmittedPdb() else null,
        // https://github.com/ziglang/zig/issues/9698
        .emitted_h = null,
        .emitted_implib = if (implib_dir != null) artifact.getEmittedImplib() else null,

        .artifact = artifact,
    };

    install_artifact.step.dependOn(&artifact.step);

    return install_artifact;
}