mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-13 04:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make addFilePost* functions' documentation more clear

Browse Source
This commit is contained in:
LeRoyce Pearson 2020-04-14 22:17:55 -06:00 committed by Andrew Kelley
parent e7657f2938
commit b429f4607c
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/std/cache_hash.zig
View File

@ -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);