Commit b429f4607c320118f5e0443605b29dda39521204 | zig

author	LeRoyce Pearson <leroycepearson@geemili.xyz> 2020-04-14 22:17:55-06:00
committer	Andrew Kelley <andrew@ziglang.org> 2020-05-25 13:48:43-04:00
log	b429f4607c320118f5e0443605b29dda39521204
tree	7288845af478d7399431a3c0856033c7b73d0410
parent	e7657f2938e9061a546c5ad726a9575ad6a8eba3

1 files changed, 8 insertions(+), 2 deletions(-)

lib/std/cache_hash.zig+8-2

 @@ -258,7 +258,11 @@ pub const CacheHash = struct {
     }
     /// Add a file as a dependency of process being cached, after the initial hash has been
-    /// calculated. Returns the contents of the file, allocated with the given allocator.
+    /// calculated. This is useful for processes that don't know the all the files that
+    /// are depended on ahead of time. For example, a source file that can import other files
+    /// will need to be recompiled if the imported file is changed.
+    ///
+    /// Returns the contents of the file, allocated with the given allocator.
     pub fn addFilePostFetch(self: *@This(), otherAlloc: *mem.Allocator, file_path: []const u8) ![]u8 {
         debug.assert(self.manifest_file != null);
 @@ -269,7 +273,9 @@ pub const CacheHash = struct {
     }
     /// Add a file as a dependency of process being cached, after the initial hash has been
-    /// calculated.
+    /// calculated. This is useful for processes that don't know the all the files that
+    /// are depended on ahead of time. For example, a source file that can import other files
+    /// will need to be recompiled if the imported file is changed.
     pub fn addFilePost(self: *@This(), file_path: []const u8) !void {
         const contents = try self.addFilePostFetch(self.alloc, file_path);
         self.alloc.free(contents);