Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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 standard library. Public Struct

Options

Public Struct
std.Build.Step.InstallArtifact.Options
pub const Options = struct

Fields

dest_dir: Dir = .default

Which installation directory to put the main output file into.

pdb_dir: Dir = .default
compiler_rt_dyn_lib_dir: Dir = .default
h_dir: Dir = .default
implib_dir: Dir = .default
dylib_symlinks: ?bool = null

Whether to install symlinks along with dynamic libraries.

dest_sub_path: ?[]const u8 = null

If non-null, adds additional path components relative to bin dir, and overrides the basename of the Compile step for installation purposes.

Types

File

Build/Step/InstallArtifact.zig:34
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
pub const Options = struct {
    /// Which installation directory to put the main output file into.
    dest_dir: Dir = .default,
    pdb_dir: Dir = .default,
    compiler_rt_dyn_lib_dir: Dir = .default,
    h_dir: Dir = .default,
    implib_dir: Dir = .default,

    /// Whether to install symlinks along with dynamic libraries.
    dylib_symlinks: ?bool = null,
    /// If non-null, adds additional path components relative to bin dir, and
    /// overrides the basename of the Compile step for installation purposes.
    dest_sub_path: ?[]const u8 = null,

    pub const Dir = union(enum) {
        disabled,
        default,
        override: InstallDir,
    };
}