From 6fc4b144a24b7a4d2dd517b017aad4ef1bc11432 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Tue, 14 Feb 2023 14:28:45 -0800 Subject: [PATCH] build: update libtool step docs --- src/build/LibtoolStep.zig | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/build/LibtoolStep.zig b/src/build/LibtoolStep.zig index 0870073eb..e3395c880 100644 --- a/src/build/LibtoolStep.zig +++ b/src/build/LibtoolStep.zig @@ -1,5 +1,5 @@ -//! A zig builder step that runs "lipo" on two binaries to create -//! a universal binary. +//! A zig builder step that runs "libtool" against a list of libraries +//! in order to create a single combined static library. const LibtoolStep = @This(); const std = @import("std"); @@ -8,13 +8,14 @@ const FileSource = std.build.FileSource; const GeneratedFile = std.build.GeneratedFile; pub const Options = struct { - /// The name of the xcframework to create. + /// The name of this step. name: []const u8, - /// The filename (not the path) of the file to create. + /// The filename (not the path) of the file to create. This will + /// be placed in a unique hashed directory. Use out_path to access. out_name: []const u8, - /// Library file (dylib, a) to package. + /// Library files (.a) to combine. sources: []FileSource, };