authorgravatar for squeek502@hotmail.comRyan Liptak <squeek502@hotmail.com> 2023-07-27 13:57:41-07:00
committergravatar for squeek502@hotmail.comRyan Liptak <squeek502@hotmail.com> 2023-10-20 23:25:43-07:00
logfb5f69a55283e65a8ae9508e74b9eefedc3ac3da
treefdcfc9fa0242d6ed45d33ed8939711c7531af9a6
parent63b504219d119a13731811065d18a2b10b4214b3

Improve Dir.makePath and Dir.makeOpenPathAccessMaskW doc comments

These are not recursive functions, so 'recursively' could be misleading.

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

lib/std/fs.zig+6-5
...@@ -1459,8 +1459,9 @@ pub const Dir = struct {...@@ -1459,8 +1459,9 @@ pub const Dir = struct {
1459 try os.mkdiratW(self.fd, sub_path, default_new_dir_mode);1459 try os.mkdiratW(self.fd, sub_path, default_new_dir_mode);
1460 }1460 }
14611461
1462 /// Calls makeDir recursively to make an entire path. Returns success if the path1462 /// Calls makeDir iteratively to make an entire path
1463 /// already exists and is a directory.1463 /// (i.e. creating any parent directories that do not exist).
1464 /// Returns success if the path already exists and is a directory.
1464 /// This function is not atomic, and if it returns an error, the file system may1465 /// This function is not atomic, and if it returns an error, the file system may
1465 /// have been modified regardless.1466 /// have been modified regardless.
1466 pub fn makePath(self: Dir, sub_path: []const u8) !void {1467 pub fn makePath(self: Dir, sub_path: []const u8) !void {
...@@ -1483,9 +1484,9 @@ pub const Dir = struct {...@@ -1483,9 +1484,9 @@ pub const Dir = struct {
1483 }1484 }
1484 }1485 }
14851486
1486 /// Calls makeOpenDirAccessMaskW recursively to make an entire path1487 /// Calls makeOpenDirAccessMaskW iteratively to make an entire path
1487 /// (i.e. falling back if the parent directory does not exist). Opens the dir if the path1488 /// (i.e. creating any parent directories that do not exist).
1488 /// already exists and is a directory.1489 /// Opens the dir if the path already exists and is a directory.
1489 /// This function is not atomic, and if it returns an error, the file system may1490 /// This function is not atomic, and if it returns an error, the file system may
1490 /// have been modified regardless.1491 /// have been modified regardless.
1491 fn makeOpenPathAccessMaskW(self: Dir, sub_path: []const u8, access_mask: u32, no_follow: bool) OpenError!Dir {1492 fn makeOpenPathAccessMaskW(self: Dir, sub_path: []const u8, access_mask: u32, no_follow: bool) OpenError!Dir {