From 595f1f12944eda9c262a93b40d8c1cfc3fe6eb9f Mon Sep 17 00:00:00 2001 From: Ryan Liptak Date: Thu, 27 Jul 2023 13:57:41 -0700 Subject: [PATCH] Improve Dir.makePath and Dir.makeOpenPathAccessMaskW doc comments These are not recursive functions, so 'recursively' could be misleading. --- lib/std/fs.zig | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/std/fs.zig b/lib/std/fs.zig index ab296a8fb08d..5da3d901ae23 100644 --- a/lib/std/fs.zig +++ b/lib/std/fs.zig @@ -1459,8 +1459,9 @@ pub const Dir = struct { try os.mkdiratW(self.fd, sub_path, default_new_dir_mode); } - /// Calls makeDir recursively to make an entire path. Returns success if the path - /// already exists and is a directory. + /// Calls makeDir iteratively to make an entire path + /// (i.e. creating any parent directories that do not exist). + /// Returns success if the path already exists and is a directory. /// This function is not atomic, and if it returns an error, the file system may /// have been modified regardless. pub fn makePath(self: Dir, sub_path: []const u8) !void { @@ -1483,9 +1484,9 @@ pub const Dir = struct { } } - /// Calls makeOpenDirAccessMaskW recursively to make an entire path - /// (i.e. falling back if the parent directory does not exist). Opens the dir if the path - /// already exists and is a directory. + /// Calls makeOpenDirAccessMaskW iteratively to make an entire path + /// (i.e. creating any parent directories that do not exist). + /// Opens the dir if the path already exists and is a directory. /// This function is not atomic, and if it returns an error, the file system may /// have been modified regardless. fn makeOpenPathAccessMaskW(self: Dir, sub_path: []const u8, access_mask: u32, no_follow: bool) OpenError!Dir {