mirror of
https://codeberg.org/ziglang/zig.git
synced 2025-12-06 05:44:20 +00:00
6b020c3d15
Clarify the usage of .paths in build.zig.zon. Follow the recommendation of the comments to explicitly list paths by explicitly listing the paths in the init project.
64 lines
2.9 KiB
Zig
64 lines
2.9 KiB
Zig
.{
|
|
.name = "$",
|
|
// This is a [Semantic Version](https://semver.org/).
|
|
// In a future version of Zig it will be used for package deduplication.
|
|
.version = "0.0.0",
|
|
|
|
// This field is optional.
|
|
// This is currently advisory only; Zig does not yet do anything
|
|
// with this value.
|
|
//.minimum_zig_version = "0.11.0",
|
|
|
|
// This field is optional.
|
|
// Each dependency must either provide a `url` and `hash`, or a `path`.
|
|
// `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
|
|
// Once all dependencies are fetched, `zig build` no longer requires
|
|
// internet connectivity.
|
|
.dependencies = .{
|
|
// See `zig fetch --save <url>` for a command-line interface for adding dependencies.
|
|
//.example = .{
|
|
// // When updating this field to a new URL, be sure to delete the corresponding
|
|
// // `hash`, otherwise you are communicating that you expect to find the old hash at
|
|
// // the new URL.
|
|
// .url = "https://example.com/foo.tar.gz",
|
|
//
|
|
// // This is computed from the file contents of the directory of files that is
|
|
// // obtained after fetching `url` and applying the inclusion rules given by
|
|
// // `paths`.
|
|
// //
|
|
// // This field is the source of truth; packages do not come from a `url`; they
|
|
// // come from a `hash`. `url` is just one of many possible mirrors for how to
|
|
// // obtain a package matching this `hash`.
|
|
// //
|
|
// // Uses the [multihash](https://multiformats.io/multihash/) format.
|
|
// .hash = "...",
|
|
//
|
|
// // When this is provided, the package is found in a directory relative to the
|
|
// // build root. In this case the package's hash is irrelevant and therefore not
|
|
// // computed. This field and `url` are mutually exclusive.
|
|
// .path = "foo",
|
|
|
|
// // When this is set to `true`, a package is declared to be lazily
|
|
// // fetched. This makes the dependency only get fetched if it is
|
|
// // actually used.
|
|
// .lazy = false,
|
|
//},
|
|
},
|
|
|
|
// Specifies the set of files and directories that are included in this package.
|
|
// Only files and directories listed here are included in the `hash` that
|
|
// is computed for this package. Only files listed here will remain on disk
|
|
// when using the zig package manager. As a rule of thumb, one should list
|
|
// files required for compilation plus any license(s).
|
|
// Paths are relative to the build root. Use the empty string (`""`) to refer to
|
|
// the build root itself.
|
|
// A directory listed here means that all files within, recursively, are included.
|
|
.paths = .{
|
|
"build.zig",
|
|
"build.zig.zon",
|
|
"src",
|
|
// For example...
|
|
//"LICENSE",
|
|
//"README.md",
|
|
},
|
|
}
|