authorgravatar for tim@timculverhouse.comTim Culverhouse <tim@timculverhouse.com> 2024-05-22 17:03:17-05:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-06-06 10:44:15-07:00
logce9d2eda731acf76fece8d720945ef63c36facba
tree02d33e890f42a0b2c045731eddfa4c03022642b7
parentd6eac43a5b1f9d353ac4bdc24f3daf5ce4b1dc1b

init: clarify .paths usage in build.zig.zon

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.

1 files changed, 6 insertions(+), 9 deletions(-)

lib/init/build.zig.zon+6-9
...@@ -47,20 +47,17 @@...@@ -47,20 +47,17 @@
4747
48 // Specifies the set of files and directories that are included in this package.48 // Specifies the set of files and directories that are included in this package.
49 // Only files and directories listed here are included in the `hash` that49 // Only files and directories listed here are included in the `hash` that
50 // is computed for this package.50 // is computed for this package. Only files listed here will remain on disk
51 // when using the zig package manager. As a rule of thumb, one should list
52 // files required for compilation plus any license(s).
51 // Paths are relative to the build root. Use the empty string (`""`) to refer to53 // Paths are relative to the build root. Use the empty string (`""`) to refer to
52 // the build root itself.54 // the build root itself.
53 // A directory listed here means that all files within, recursively, are included.55 // A directory listed here means that all files within, recursively, are included.
54 .paths = .{56 .paths = .{
55 // This makes *all* files, recursively, included in this package. It is generally57 "build.zig",
56 // better to explicitly list the files and directories instead, to insure that58 "build.zig.zon",
57 // fetching from tarballs, file system paths, and version control all result59 "src",
58 // in the same contents hash.
59 "",
60 // For example...60 // For example...
61 //"build.zig",
62 //"build.zig.zon",
63 //"src",
64 //"LICENSE",61 //"LICENSE",
65 //"README.md",62 //"README.md",
66 },63 },