Build
Fields of this type
Fields
- graph:*Graph
- Shared state among all Build instances.
- available_options_list:std.array_list.Managed(AvailableOption)
- verbose:bool
- verbose_link:bool
- verbose_cc:bool
- verbose_air:bool
- verbose_llvm_ir:?[]const u8
- verbose_llvm_bc:?[]const u8
- verbose_cimport:bool
- verbose_llvm_cpu_features:bool
- reference_trace:?u32
- = null
- invalid_user_input:bool
- default_step:*Step
- top_level_steps:std.StringArrayHashMapUnmanaged(*TopLevelStep)
- install_prefix:[]const u8
- dest_dir:?[]const u8
- lib_dir:[]const u8
- exe_dir:[]const u8
- h_dir:[]const u8
- install_path:[]const u8
- sysroot:?[]const u8
- = null
- search_prefixes:ArrayList([]const u8)
- libc_file:?[]const u8
- = null
- build_root:Cache.Directory
- Path to the directory containing build.zig.
- cache_root:Cache.Directory
- pkg_config_pkg_list:?(PkgConfigError![]const PkgConfigPkg)
- = null
- args:?[]const []const u8
- = null
- debug_log_scopes:[]const []const u8
- = &.{}
- debug_compile_errors:bool
- = false
- debug_incremental:bool
- = false
- debug_pkg_config:bool
- = false
- debug_stack_frames_count:u8
- Number of stack frames captured when a `StackTrace` is recorded for debug purposes,
- enable_darling:bool
- Experimental.
- enable_qemu:bool
- Use system QEMU installation to run cross compiled foreign architecture build artifacts.
- enable_rosetta:bool
- Darwin.
- enable_wasmtime:bool
- Use system Wasmtime installation to run cross compiled wasm/wasi build artifacts.
- enable_wine:bool
- Use system Wine installation to run cross compiled Windows build artifacts.
- libc_runtimes_dir:?[]const u8
- After following the steps in https://github.com/ziglang/zig/wiki/Updating-libc#glibc,
- dep_prefix:[]const u8
- = ""
- modules:std.StringArrayHashMap(*Module)
- named_writefiles:std.StringArrayHashMap(*Step.WriteFile)
- named_lazy_paths:std.StringArrayHashMap(LazyPath)
- pkg_hash:[]const u8
- The hash of this instance's package.
- available_deps:AvailableDeps
- A mapping from dependency names to package hashes.
- build_id:?std.zig.BuildId
- = null
Type definitions in this namespace
Types
- Graph
- Shared state among all Build instances.
- GeneratedFile
- A file that is generated by a build step.
- LazyPath
- A reference to an existing or future path.
- ResolvedTarget
- A pair of target query and fully resolved target.
Functions in this namespace
Functions
- resolveInstallPrefix
- This function is intended to be called by lib/build_runner.zig, not a build.zig file.
- addOptions
- Create a set of key-value pairs that can be converted into a Zig source
- addTest
- Creates an executable containing unit tests.
- addModule
- This function creates a module and adds it to the package's module set, making
- createModule
- This function creates a private module, to be used by the current package,
- addSystemCommand
- Initializes a `Step.Run` with argv, which must at least have the path to the
- addRunArtifact
- Creates a `Step.Run` with an executable built with `addExecutable`.
- addConfigHeader
- Using the `values` provided, produces a C header file, possibly based on a
- dupe
- Allocator.dupe without the need to handle out of memory.
- dupeStrings
- Duplicates an array of strings without the need to handle out of memory.
- dupePath
- Duplicates a path and converts all slashes to the OS's canonical path separator.
- option
- Creates a configuration option to be passed to the build.zig script.
- standardTargetOptions
- Exposes standard `zig build` options for choosing a target and additionally
- parseTargetQuery
- Obtain a target query from a string, reporting diagnostics to stderr if the
- standardTargetOptionsQueryOnly
- Exposes standard `zig build` options for choosing a target.
- installArtifact
- This creates the install step and adds it to the dependencies of the
- addInstallArtifact
- This merely creates the step; it does not add it to the dependencies of the
- installFile
- `dest_rel_path` is relative to prefix path
- installBinFile
- `dest_rel_path` is relative to bin path
- installLibFile
- `dest_rel_path` is relative to lib path
- addInstallFile
- `dest_rel_path` is relative to install prefix path
- addInstallBinFile
- `dest_rel_path` is relative to bin path
- addInstallLibFile
- `dest_rel_path` is relative to lib path
- addInstallHeaderFile
- `dest_rel_path` is relative to header path
- path
- References a file or directory relative to the source root.
- pathFromRoot
- This is low-level implementation details of the build system, not meant to
- run
- This is a helper function to be called from build.zig scripts, *not* from
- lazyDependency
- When this function is called, it means that the current build does, in
- lazyImport
- In a build.zig file, this function is to `@import` what `lazyDependency` is to `dependency`.
- dumpBadGetPathHelp
- In this function the stderr mutex has already been locked.
- makeTempPath
- This function is intended to be called in the `configure` phase only.
- resolveTargetQuery
- Converts a target query into a fully resolved target that can be passed to
Error sets in this namespace