build: update libtool step docs

This commit is contained in:
Mitchell Hashimoto
2023-02-14 14:28:45 -08:00
parent d2d21801d8
commit 6fc4b144a2

View File

@ -1,5 +1,5 @@
//! A zig builder step that runs "lipo" on two binaries to create //! A zig builder step that runs "libtool" against a list of libraries
//! a universal binary. //! in order to create a single combined static library.
const LibtoolStep = @This(); const LibtoolStep = @This();
const std = @import("std"); const std = @import("std");
@ -8,13 +8,14 @@ const FileSource = std.build.FileSource;
const GeneratedFile = std.build.GeneratedFile; const GeneratedFile = std.build.GeneratedFile;
pub const Options = struct { pub const Options = struct {
/// The name of the xcframework to create. /// The name of this step.
name: []const u8, 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, out_name: []const u8,
/// Library file (dylib, a) to package. /// Library files (.a) to combine.
sources: []FileSource, sources: []FileSource,
}; };