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

Improve Dir.makePath and Dir.makeOpenPathAccessMaskW doc comments

Browse Source 
These are not recursive functions, so 'recursively' could be misleading.
This commit is contained in:
Ryan Liptak 2023-07-27 13:57:41 -07:00
parent 63b504219d
commit fb5f69a552
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/std/fs.zig
View File

@ -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 {