From 77c63ac36034db577a9287c54fb6771429a7428f Mon Sep 17 00:00:00 2001 From: Jonathan Marler Date: Sat, 17 Aug 2024 19:29:26 -0600 Subject: [PATCH] doc: mention zig can't use URLs if their content changes There's been some proliferation of dependency URLs that reference mutable data such as links to git branches that can change. This has resulted in broken projects, i.e. * https://github.com/RohanVashisht1234/raylib_rain_train/blob/9eef9de94c511f2eb4fe5db1d6abd574ee245c9b/build.zig.zon * https://github.com/rcmagic/ZigFightingGame/commit/4b64353e9c69de0fa2eb87fa9c3a3da76a8a3e7b There's also disagreement about whether it's fine for URL's to point to git branches, i.e. https://github.com/Not-Nik/raylib-zig/pull/130 This updates the docs to mention that zig won't be able to use URLs if their content changes. --- doc/build.zig.zon.md | 3 ++- lib/init/build.zig.zon | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/build.zig.zon.md b/doc/build.zig.zon.md index d0740a9237..dc3ac749a9 100644 --- a/doc/build.zig.zon.md +++ b/doc/build.zig.zon.md @@ -47,7 +47,8 @@ String. 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. +the new URL. If the contents of a URL change this will result in a hash mismatch +which will prevent zig from using it. #### `hash` diff --git a/lib/init/build.zig.zon b/lib/init/build.zig.zon index c06abec206..cb7229042f 100644 --- a/lib/init/build.zig.zon +++ b/lib/init/build.zig.zon @@ -27,7 +27,8 @@ //.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. + // // the new URL. If the contents of a URL change this will result in a hash mismatch + // // which will prevent zig from using it. // .url = "https://example.com/foo.tar.gz", // // // This is computed from the file contents of the directory of files that is