Last updated: 2026-11-17

CLI & Entrypoints

Build Info

All API Sections

Build metadata exported by `build.zig` for CLI version reporting.

The values in this module are generated at compile time from build options such as `-Dversion` and `-Dcommit`, then printed by `zinc --version`.

8 exports 0 methods src/build_info.zig

8 exports shown

constant

version

#
pub const version = build_options.version

Semantic version string for this build (from `-Dversion`, e.g.

`0.3.1`).

src/build_info.zig:10

constant

commit

#
pub const commit = build_options.commit

Short git commit hash this binary was built from (from `-Dcommit`).

src/build_info.zig:12

constant

target

#
pub const target = build_options.target

Compilation target triple this binary was built for (from `-Dtarget`).

src/build_info.zig:14

constant

optimize

#
pub const optimize = build_options.optimize

Active optimize mode, e.g.

`ReleaseFast` or `Debug` (from `-Doptimize`).

src/build_info.zig:16

constant

backend

#
pub const backend = build_options.backend

Single GPU backend compiled into this binary, e.g.

`vulkan`, `rocm`, or `metal`.

src/build_info.zig:18

struct

Metadata

#
pub const Metadata = struct

Memory Layout

Size: 80 bytes (alignment: 8)

Offset Size Align Field Type
0 16 8 version []const u8
16 16 8 commit []const u8
32 16 8 target []const u8
48 16 8 optimize []const u8
64 16 8 backend []const u8

Shared identity for CLI JSON, diagnostics and HTTP discovery.

src/build_info.zig:21

function

writeVersionJson

#
pub fn writeVersionJson(writer: *std.Io.Writer) !void

No public doc comment yet.

src/build_info.zig:29

function

writeVersion

#
pub fn writeVersion(writer: anytype) !void

Write the full `zinc --version` report to `writer`.

Emits the version, commit, target, optimize mode, and compiled-in backend, each on its own line. The `backends` output key is retained for compatibility.

Parameters

writer
Destination writer that receives the formatted metadata block.

Returns

Propagates only the writer's own error if printing fails.

src/build_info.zig:40